Command reference - Octonote AI

Add --help to any command in your terminal for the same details.

Global options

These work with every command.

Option	What it does
`—json`	JSON output (default when piped)
`—pretty`	human output (default in a terminal)
`-q, —quiet`	no progress messages
`-w, —workspace <id>`	workspace to use (default: yours)
`—api-url <url>`	Octonote API (default: OCTONOTE_API_URL or the hosted API)
`—web-url <url>`	Octonote web app (default: OCTONOTE_WEB_URL or https://octonote.ai)

Commands

Command	What it does
`login`	Sign in through the browser (or —paste a token from Settings → CLI & agents)
`logout`	Sign out here and revoke this computer’s token
`whoami`	Who you’re signed in as, and which workspace commands use
`account rename`	Change your display name (shown in the app and as the author of pages you publish)
`workspace list`	Workspaces you belong to
`workspace use`	Use this workspace from now on (id or exact name)
`token list`	List your tokens
`token revoke`	Revoke a token
`note create`	Create a note, optionally filled from markdown
`note show`	Print a note as markdown
`note pull`	Save a note to a markdown file (with front matter, so `note push` knows which note it is)
`note push`	Replace a note’s content with a markdown file (uses the file’s front matter id, or —id)
`note append`	Add markdown to the end of a note
`note rename`	Rename a note
`canvas create`	Create a canvas — drawn from a mermaid flowchart or class diagram, from canvas JSON, or empty
`canvas redraw`	Replace a canvas with a drawing of a mermaid flowchart or class diagram
`canvas pull`	Save a canvas as JSON (Octonote canvas format: { version: 1, items })
`canvas push`	Replace a canvas with canvas JSON (from `canvas pull`)
`project create`	Create a project; fill its note from markdown and draw its canvas from mermaid in one go
`project show`	Show a project and the ids of its note and canvas
`notebook list`	List notebooks with what’s inside
`notebook create`	Create a notebook
`notebook show`	Show a notebook (id or exact name)
`list`	List notes, canvases, projects and notebooks (newest first)
`search`	Find notes, canvases, projects and notebooks by title
`open`	Print the app link for an item (and open it when run in a terminal)
`move`	Move a note, canvas or project into a notebook (or out with —out)
`rename`	Rename a note, canvas, project or notebook
`delete`	Delete a note, canvas, project or notebook (a notebook’s contents move to the top level)
`publish`	Publish to the web; prints the public URL
`unpublish`	Stop publishing to the web
`share`	Share with a person by email, or set who can open the link
`guide`	Print the usage guide for AI agents (Claude Code, Codex, …)
`setup`	Teach an agent to use Octonote: writes a section into CLAUDE.md (claude) or AGENTS.md (codex)