> ## Documentation Index
> Fetch the complete documentation index at: https://docs.octonote.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the CLI

> Get the octonote command on macOS, Linux or Windows.

The `octonote` CLI lets you, and agents like Claude Code and Codex, create, read, edit, publish and share your notes, canvases, projects and notebooks from a terminal. It needs **Node.js 20 or newer**.

**1. Get Node.js**

**macOS**

```bash theme={null}
brew install node
```

Or the installer from [nodejs.org](https://nodejs.org).

**Windows**

```powershell theme={null}
winget install OpenJS.NodeJS.LTS
```

Or the installer from [nodejs.org](https://nodejs.org).

**Linux**

Use your distribution's package manager, [nvm](https://github.com/nvm-sh/nvm), or the binaries from [nodejs.org](https://nodejs.org).

**2. Install the CLI**

```bash theme={null}
npm i -g @octonote/cli
```

No PATH setup needed: npm puts `octonote` next to `node`. Run `octonote` on its own to see how to get started.

> **npm registry blocked? Install from octonote.ai**
>
> The same package, served from our site:
>
> ```bash theme={null}
> npm i -g https://octonote.ai/cli/octonote-cli.tgz
> ```

**3. Sign in**

```bash theme={null}
octonote login
```

This opens octonote.ai in your browser. Click **Authorize** and you're done. See [Sign-in and tokens](https://docs.octonote.ai/cli/authentication.md) for agents and CI.

## Next

> **[Use it with Claude Code](https://docs.octonote.ai/agents/claude-code.md)**
>
> One command teaches Claude to save and find your notes.

> **[Command reference](https://docs.octonote.ai/cli/reference/overview.md)**
>
> Every command and option.

## Update or remove

```bash theme={null}
npm i -g @octonote/cli@latest   # update
npm rm -g @octonote/cli          # remove
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.