# Octonote AI

> Docs for Octonote AI, the workspace for humans and agents: notes and canvases side by side, written by you, Claude Code or Codex.

- [Octonote AI docs](https://docs.octonote.ai/index.md): The workspace for humans and agents: notes and canvases side by side, written by you, Claude Code or Codex, and published as beautiful pages.
- [Quickstart](https://docs.octonote.ai/quickstart.md): Your first note, canvas and published page in five minutes.
- [Notes](https://docs.octonote.ai/guides/notes.md): A block editor that speaks code, math and diagrams.
- [Canvases](https://docs.octonote.ai/guides/canvases.md): An infinite canvas for flows, maps and architecture diagrams, with diagrams you write as code.
- [Projects](https://docs.octonote.ai/guides/projects.md): One note and one canvas, side by side.
- [Notebooks](https://docs.octonote.ai/guides/notebooks.md): Folders for notes, canvases and projects, which publish as a small website.
- [Home and search](https://docs.octonote.ai/guides/home-and-search.md): Find your recent work, what's shared with you, and anything by name.
- [Sharing](https://docs.octonote.ai/guides/sharing.md): Share with people by email, or with anyone who has the link.
- [Publishing](https://docs.octonote.ai/guides/publishing.md): Turn a note, canvas, project or whole notebook into a public page.
- [Analytics](https://docs.octonote.ai/guides/analytics.md): See how many people read your published pages, without tracking them.
- [Plans and billing](https://docs.octonote.ai/guides/plans.md): Free to start; Pro for unlimited notes, canvases, projects and notebooks.
- [Students](https://docs.octonote.ai/guides/students.md): Pro free for 12 months with your school email.
- [Account and settings](https://docs.octonote.ai/guides/settings.md): Sign-in, your name, appearance, privacy, workspaces and deleting your account.
- [Octonote for agents](https://docs.octonote.ai/agents/overview.md): Let Claude Code and Codex write, find and publish your notes and diagrams.
- [Claude and ChatGPT](https://docs.octonote.ai/agents/claude-and-chatgpt.md): Use Octonote from Claude.ai, ChatGPT and Gemini CLI: no install, just sign in.
- [Claude Code](https://docs.octonote.ai/agents/claude-code.md): Teach Claude Code to save and find your work in Octonote.
- [Codex](https://docs.octonote.ai/agents/codex.md): Teach Codex to save and find your work in Octonote.
- [Cloud agents and CI](https://docs.octonote.ai/agents/cloud-and-ci.md): Use Octonote from Claude Code on the web, Codex cloud tasks and GitHub Actions.
- [Writing content](https://docs.octonote.ai/agents/writing-content.md): Agents write plain markdown and mermaid; Octonote turns them into rich notes and real canvases.
- [What your agent reads](https://docs.octonote.ai/agents/agent-guide.md): The exact text octonote setup adds to CLAUDE.md or AGENTS.md, and the full guide agents load.
- [Install the CLI](https://docs.octonote.ai/cli/install.md): Get the octonote command on macOS, Linux or Windows.
- [Sign-in and tokens](https://docs.octonote.ai/cli/authentication.md): How the CLI signs in, and how agents and CI use a token instead.
- [Output and errors](https://docs.octonote.ai/cli/output-and-errors.md): What scripts and agents can rely on: JSON output, errors and exit codes.
- [Troubleshooting](https://docs.octonote.ai/cli/troubleshooting.md): Fixes for the problems people hit most.
- [Command reference](https://docs.octonote.ai/cli/reference/overview.md): Every command in octonote 0.1.6, read from the CLI itself.
- [Account](https://docs.octonote.ai/cli/reference/account.md): Sign in, pick a workspace, manage tokens.
- [Notes](https://docs.octonote.ai/cli/reference/notes.md): Markdown in, rich notes out. Pull a note to a file, edit it, push it back.
- [Canvases](https://docs.octonote.ai/cli/reference/canvases.md): Write a mermaid flowchart; Octonote lays it out as real, editable shapes.
- [Projects](https://docs.octonote.ai/cli/reference/projects.md): A note and a canvas side by side, created in one command.
- [Notebooks](https://docs.octonote.ai/cli/reference/notebooks.md): Folders for notes, canvases and projects. Refer to them by exact name or id.
- [Find & organise](https://docs.octonote.ai/cli/reference/organise.md): Works on any item. The id says what it is: pag_ note, cnv_ canvas, prj_ project, ntb_ notebook.
- [Publish & share](https://docs.octonote.ai/cli/reference/sharing.md): Publish to a public page, or share with people. The same rules as the app.
- [Agent setup](https://docs.octonote.ai/cli/reference/agents.md): Teach Claude Code or Codex to use Octonote.


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