# Install the CLI

> Install the Notate CLI from npm and sign in to your account.

Source: https://notate.md/docs/cli/install/

Category: CLI

Updated: 2026-08-16

---

The Notate CLI is a command-line client for your notes, published on npm as [`@notatemd/cli`](https://www.npmjs.com/package/@notatemd/cli). It is a pure REST client: it talks to the Notate API and works against the same account and notes as the desktop, mobile, and web apps, with no local database to set up. For an overview of what it can do, see the [CLI page](https://notate.md/cli/).

## Requirements

- Node.js 20 or newer.
- An account with the **Sync plan** (or AI plan). The CLI works against your synced notes on the server, so there is nothing for it to reach on the Free, local-only plan.

## Install

Install it globally so the `notate` command is on your path:

```bash
npm install -g @notatemd/cli
notate --help
```

Or run it without installing anything:

```bash
npx @notatemd/cli --help
```

## Sign in

The CLI talks to the hosted Notate API by default. Log in with your Notate account:

```bash
notate login          # prompts for your password
notate whoami         # confirm the signed-in account
```

`login` prompts for your password, and for your email if you do not pass `--email`. Your access and refresh tokens are stored in your operating system keychain, not in a plaintext file. Run `notate logout` to clear them.

## First capture

Pick a default workspace so you can skip `--workspace` on every command, then create a note:

```bash
notate workspaces use "My Workspace"
notate notes create "My first CLI note" --content "# Hello from the terminal"
notate notes list
```

The note syncs like any other, so it shows up in every Notate app.

Next: the [command reference](https://notate.md/docs/cli/commands/).