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

# Octonote for agents

> Let Claude Code and Codex write, find and publish your notes and diagrams.

Octonote is a workspace for humans **and** agents. Your agent writes with the same notes, canvases, projects and notebooks you use in the app, through the `octonote` CLI. It writes markdown and mermaid; Octonote turns them into rich notes and real, editable canvases.

**1. Install and sign in, once per computer**

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

**2. Tell your agent about Octonote, once**

```bash theme={null}
octonote setup claude --skill   # Claude Code
octonote setup codex            # Codex
```

**3. Just ask**

"Write up what we decided about the cache as a note in my Architecture notebook, with a diagram."

> [!TIP]
>
> Using Claude.ai or ChatGPT in the browser? Connect Octonote there with no install: see [Claude and ChatGPT](https://docs.octonote.ai/agents/claude-and-chatgpt.md).

> **[Claude Code](https://docs.octonote.ai/agents/claude-code.md)**
>
> CLAUDE.md, the Octonote skill and permissions.

> **[Codex](https://docs.octonote.ai/agents/codex.md)**
>
> AGENTS.md and the network sandbox.

> **[Cloud agents and CI](https://docs.octonote.ai/agents/cloud-and-ci.md)**
>
> Claude Code on the web, Codex cloud, GitHub Actions.

> **[Writing content](https://docs.octonote.ai/agents/writing-content.md)**
>
> The markdown and mermaid agents write.

## What to ask

| You say | Your agent runs |
| - | - |
| "Write up this decision as a note in my Architecture notebook." | `octonote note create --file … --notebook Architecture` |
| "Draw this flow as a canvas and publish it." | `octonote canvas create --from-mermaid flow.mmd --publish` |
| "Document the auth flow with a diagram, side by side." | `octonote project create --note … --canvas-mermaid …` |
| "Add today's progress to my Build log note." | `octonote search "Build log"` → `octonote note append …` |
| "Update my Onboarding note with these changes." | `octonote note pull …` → edit → `octonote note push …` |
| "What did we decide about rate limits?" | `octonote search "rate limit"` → `octonote note show …` |
| "Share it with [sam@example.com](mailto:sam@example.com) as an editor." | `octonote share … --email sam@example.com --role editor` |

> [!NOTE]
>
> Agents only publish, share or delete when you ask for it. The guide they read tells them so, and `delete` needs `--yes`.


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