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

# Notes

> Markdown in, rich notes out. Pull a note to a file, edit it, push it back.

```bash theme={null}
octonote note create "Plan" --file plan.md --notebook "Work" --publish
cat log.md | octonote note create "Build log" --stdin
octonote note pull pag_… -o plan.md     # edit plan.md…
octonote note push plan.md
octonote note append pag_… --text "- shipped the CLI"
```

## note create

Create a note, optionally filled from markdown

```bash theme={null}
octonote note create [title] [options]
```

| Argument or option | What it does |
| - | - |
| `<title>` | title (defaults to the file's front matter / first heading) (optional) |
| `-f, --file <path>` | markdown file ("-" for stdin) |
| `--stdin` | read markdown from stdin |
| `-n, --notebook <notebook>` | put it in a notebook (id or exact name) |
| `--publish` | publish it to the web and print the public URL |

## note show

Print a note as markdown. Alias: `read`.

```bash theme={null}
octonote note show <note>
```

| Argument or option | What it does |
| - | - |
| `<note>` | note id (pag\_…) or URL (required) |

## note pull

Save a note to a markdown file (with front matter, so `note push` knows which note it is)

```bash theme={null}
octonote note pull <note> [options]
```

| Argument or option | What it does |
| - | - |
| `<note>` | note id (pag\_…) or URL (required) |
| `-o, --out <path>` | file to write (default: \<id>.md) |

## note push

Replace a note's content with a markdown file (uses the file's front matter id, or --id)

```bash theme={null}
octonote note push <file> [options]
```

| Argument or option | What it does |
| - | - |
| `<file>` | markdown file ("-" for stdin) (required) |
| `--id <note>` | note to update (overrides the front matter) |

## note append

Add markdown to the end of a note

```bash theme={null}
octonote note append <note> [options]
```

| Argument or option | What it does |
| - | - |
| `<note>` | note id (pag\_…) or URL (required) |
| `-f, --file <path>` | markdown file ("-" for stdin) |
| `--stdin` | read markdown from stdin |
| `-t, --text <markdown>` | markdown given inline |

## note rename

Rename a note

```bash theme={null}
octonote note rename <note> <title>
```

| Argument or option | What it does |
| - | - |
| `<note>` | note id (pag\_…) (required) |
| `<title>` | new title (required) |


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