CLI
CLI reference
Every avo command at a glance, grouped the way avo --help groups them — author, render, present, AI, config.
New here? avo demo to see it · avo tour for a guided walkthrough ·
avo init to start a project · edit docs/*.md · avo check before every
commit · avo preview docs/x.md to view.
Every command at a glance
| Command | What it does |
|---|---|
avo init | Scaffold a project — docs, config, skill, editor adapters (interactive; --yes for CI) |
avo check [globs] | Validate docs — schemas, refs, duplicate ids (exits non-zero on errors; --json) |
avo preview <in> | Render to a temp HTML file and open it |
avo studio | THE local surface — Edit visually (schema forms or YAML), browse the built Site with live reload, Present the current doc as slides; files stay the source of truth (--port, --no-open) |
avo build | Build a static HTML site from all docs — index, sidebar nav, cross-doc links, Doc | Slides toggle on every page (--out) |
avo html / slides / pdf <in> | Render one doc to HTML, a slide deck, or a PDF (-p opens, -o writes) |
avo demo [family] [-s] | Render the built-in showcase — every block, or one family (agentic, architecture, …); bare avo demo in a terminal shows a picker (-s for slides) |
avo catalog [-p|-s] | List every block + description in the terminal, grouped by family (-p opens an HTML gallery, -s a deck) |
avo tour | A guided, hands-on walkthrough — blocks, validation, previews, decks (7 short chapters) |
avo design [slug] | Design-pattern library (106: system · AI/agent · code) — grab a template; -p/-s for the gallery |
avo block / template | Scaffold a single block or a doc template |
avo skill | Print the authoring grammar as a copy-paste system prompt |
avo theme [name] | Pick / list / create / install the theme (installs global by default; --global to apply everywhere) |
avo sync openapi <spec> | Generate an API doc from an OpenAPI spec |
avo sync csv <file> | Turn a CSV into a table/statustable/chart block (auto-suggested), or a whole doc with --out |
avo install <tool> | Install/update the skill + an AI-tool adapter (claude | cursor | copilot | windsurf) |
avo mcp | MCP client setup snippets; avo mcp --stdio runs the server (spawns @avodado/mcp) |
By group
avo --help groups the commands the same way these pages do:
Author
init · check · block · template · studio
Render
preview · html · pdf · build
Present
slides · demo · catalog · design
AI
install · skill · mcp · tour
Config
theme · sync
Conventions
- The one-doc shortcuts (
html/slides/pdf) take-o, --output <path>to write a specific file, or-p, --previewto render to a temp file and open it in your browser. - Exit codes:
0clean ·1errors present ·2CLI usage error. - Set
AVO_PLAIN=1(or run in CI) to force plain output in a TTY. See output modes. - Per-command help:
avo <command> --help.