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

# Projects

> A note and a canvas side by side, created in one command.

```bash theme={null}
octonote project create "Auth flow" --note auth.md --canvas-mermaid auth.mmd --publish
octonote project show prj_…
```

## project create

Create a project; fill its note from markdown and draw its canvas from mermaid in one go

```bash theme={null}
octonote project create <name> [options]
```

| Argument or option | What it does |
| - | - |
| `<name>` | project name (required) |
| `-d, --description <text>` | one-line description |
| `--note <path>` | markdown file for the project's note ("-" for stdin) |
| `--canvas-mermaid <path>` | mermaid flowchart or class diagram file to draw on the project's canvas |
| `--view <view>` | what readers see first: notes \| canvas \| split (default: split) |
| `-n, --notebook <notebook>` | put it in a notebook (id or exact name) |
| `--publish` | publish it to the web and print the public URL |

## project show

Show a project and the ids of its note and canvas

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

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


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