avodado
avodado docs
CLI

Author commands

Scaffold a project, validate docs, scaffold blocks and templates, and open the visual editor.

The authoring loop: scaffold once (init), then edit → check → render — with block/template to start new content and studio for visual editing.

avo init

Scaffold a project — docs, config, skill, editor adapters. An interactive wizard: it asks which AI tools you use and which theme you want.

avo init          # interactive wizard: docs/, config, skill, editor adapters
avo init --yes    # …with defaults, no prompts (CI)

See Installation for exactly what it writes.

avo check

Validate docs — schemas, doc#id refs, duplicate ids. Exits non-zero on errors, so CI can gate on it.

avo check                    # validate all docs (default: docs/**/*.md)
avo check docs/orders.md     # validate one file or glob
avo check --json             # machine-readable diagnostics

Every diagnostic carries a stable code with a mechanical fix — the full taxonomy is in Validation.

avo block / avo template

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

avo block list                        # list all 77 block types
avo block sequence                    # scaffold a doc around a sequence block → stdout
avo block sequence -o docs/orders.md  # …write it to a file
avo template list                     # list document templates (adr, design-doc, deck, …)
avo template adr -o docs/adr-001.md   # scaffold a doc from a document template

Templates include adr, design-doc, runbook, roadmap, api-spec, system-design, agent-system, design-system, postmortem, data-model, and deck.

avo studio

Open the visual editor — click a block to select, Enter to edit via schema-generated forms or raw YAML, insert from the searchable palette. Files stay the source of truth; edits are surgical rewrites of individual fenced blocks.

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

The full editing model — keyboard-first selection, in-place micro-editors, drag-to-move, live repaint when an AI edits the same file — is in the Studio guide.