> ## 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.

# Command reference

> Every command in octonote 0.1.6, read from the CLI itself.

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](https://octonote.ai)) |

## Commands

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


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