Install the CLI

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.

Get Node.js

macOS
Windows
Linux

brew install node

Or the installer from nodejs.org.

winget install OpenJS.NodeJS.LTS

Or the installer from nodejs.org.

Install the CLI

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:

npm i -g https://octonote.ai/cli/octonote-cli.tgz

octonote login

This opens octonote.ai in your browser. Click Authorize and you’re done. See Sign-in and tokens for agents and CI.

Use it with Claude Code

One command teaches Claude to save and find your notes.

Command reference

Every command and option.

Update or remove

npm i -g @octonote/cli@latest   # update
npm rm -g @octonote/cli          # remove

Agents

CLI

Next

Use it with Claude Code

Command reference

Update or remove

​Next

Use it with Claude Code

Command reference

​Update or remove

Next

Update or remove