Author commands

The everyday loop: avo init once, then edit → avo check → preview. avo block and avo template give you valid starting points, and avo studio opens the visual editor.

avo init

Set up a project. The wizard asks which AI tools you use and which theme you want, then creates the docs folder, config, and AI setup.

avo init          # interactive setup
avo init --yes    # defaults, no questions (CI)

See Installation for exactly what it creates.

avo check

Validate every doc — block schemas, doc#id references, duplicate ids. Exits with an error code when something fails, so CI can gate on it.

avo check                    # check all docs
avo check docs/orders.md     # check one file or glob
avo check --json             # machine-readable output

Every message has a stable code with a known fix — see Validation.

avo block / avo template

Scaffold a single block, or a whole doc from a template.

avo block list                        # list all 87 block types
avo block sequence                    # print a starter sequence block
avo block sequence -o docs/orders.md  # write it to a file
avo template list                     # list doc templates
avo template adr -o docs/adr-001.md   # scaffold a full doc

Eighteen templates ship: adr, design-doc, runbook, roadmap, api-spec, system-design, agent-system, design-system, postmortem, data-model, deck, migration-plan, threat-model, service-overview, release-notes, test-plan, onboarding and status-update. Every one is a finished example document rather than a skeleton — see them all on Templates.

avo studio

Open the visual editor in your browser. It starts on a Home page of your docs; open one and edit it in place — click a block, change it as a form or as YAML, and watch the page update. Your .md files stay the source of truth.

avo studio                   # opens the browser (--port, --no-open)

The full tour is in the Studio guide.