Installation

Install the CLI

avo — author, validate, render, and export Avodado documentation from the terminal. Ink TUI when interactive; plain log-friendly output in CI.

pnpm add -D @avodado/cli   # or npm / yarn

Then see it work before writing anything:

pnpm exec avo demo         # renders the built-in showcase and opens it
pnpm exec avo tour         # guided, hands-on walkthrough (7 short chapters)

Scaffold a project — avo init

avo init is an interactive wizard — it asks which AI tools you use and which theme you want, then scaffolds everything a project needs. Pass --yes to skip the wizard and scaffold with defaults (handy in CI).

What it writes:

• avodado.config.json — { "docsDir": "docs", "outDir": "dist" }
• docs/getting-started.md + docs/tutorial.md — an 80/20 quick start and a deck-first tour of every block (avo slides docs/tutorial.md)
• .avodado/skill/SKILL.md — the authoring skill (block grammar + worked examples for all 77 blocks)
• Editor adapters for the tools you pick — Claude Code (CLAUDE.md), Cursor (.cursor/rules/avodado.mdc), GitHub Copilot (.github/copilot-instructions.md), Windsurf (.windsurfrules)
• avodado.theme.json when you choose a non-default or custom theme

…so any AI agent already in your repo can author Avodado docs immediately. See Author with AI for the skill, adapters, and the MCP server.

Configuration

avo looks for avodado.config.{ts,js,mjs,json,yml,yaml} in the working directory and falls back to defaults:

{ "docsDir": "docs", "outDir": "dist" }

Output modes

Set AVO_PLAIN=1 to force plain output even in a TTY.

Exit codes

avo check exits non-zero on any error — gate CI on it.

PDF export

PDF export needs Chromium. avo pdf downloads it automatically on first use (the matching build, ~100 MB, one time). To pre-install manually: npx playwright install chromium.

Next: write your first doc.