CLI reference
The command line has seven stable verbs: init, design, apply, ask, check, reconcile, export. Run yarramate --help for the exact usage of your installed release; flags evolve between versions.
init → design → apply → ask → check → reconcile → export
create fill write read gate drift derive
init
Scaffold a native workspace and write the agent pointer into AGENTS.md and CLAUDE.md.
yarramate init <directory> [--no-pointer]
design
Continue the architecture design interview and return the next open question.
yarramate design <workspace.yaml> [--subject <document-id>#<local-id>] [--catalogue <catalogue.yaml>] [--facilitate] [--json]
--facilitate renders the same interview in plain language for a stakeholder workshop; the JSON envelope is identical with or without it.
apply
Write an operations batch to a workspace. This is the only command that writes to a model — batches compile as a complete workspace or are rejected outright, never partially.
yarramate apply <operations.yaml> <workspace.yaml> [--json]
ask
Orient a person or agent, or query the model.
yarramate ask <workspace.yaml> [--json]
yarramate ask <workspace.yaml> "<free text>" | <document-id>#<local-id> ... | <projection.yaml> [--budget <tokens>] [--neighbours <n>] [--json]
yarramate ask <workspace.yaml> --subjects [--kind <term>] [--status <status>] [--json]
yarramate ask <workspace.yaml> --kinds [--json]
yarramate ask <workspace.yaml> --advise "<topic>" [--budget <tokens>] [--neighbours <n>] [--catalogue <catalogue.yaml>] [--json]
yarramate ask <workspace.yaml> --where "<free text>" | <document-id>#<local-id> ... [--json]
yarramate ask <workspace.yaml> --next [--json]
yarramate ask <workspace.yaml> --open [--catalogue <catalogue.yaml>] [--json]
yarramate ask <workspace.yaml> --compare <from-state> <to-state> [--json]
yarramate ask <workspace.yaml> --changed <git-range> [--budget <tokens>] [--neighbours <n>] [--json]
Free text and --advise also match aka alternative labels on a subject, not just its canonical name.
check
Validate documents and references deterministically.
yarramate check <source.yaml> [source.yaml ...] [--json] [--strict]
reconcile
Compare modeled claims with attached evidence: confirmed, contradicted, or unknown, plus stale attestations and value-bearing evidence disagreements.
yarramate reconcile <workspace.yaml>
export
Derive a read-only view from the checked model.
yarramate export graph <workspace.yaml> [--out <file>]
yarramate export markdown <projection.yaml> <workspace.yaml> [--out <file>]
yarramate export markdown --changed <git-range> <workspace.yaml> [--out <file>]
yarramate export briefs <projection.yaml> <workspace.yaml> --out <directory> [--budget <tokens>]
yarramate export briefs --changed <git-range> <workspace.yaml> --out <directory> [--budget <tokens>]
yarramate export rtm <workspace.yaml> --out <directory>
yarramate export likec4 <likec4-project.yaml> <output-dir> <workspace.yaml> [--changed <git-range>]
rtm derives a requirements traceability matrix — see requirements traceability →. markdown and briefs render retired goals and requirements under a Non-goals heading. likec4 projects selected subjects into diagrams.
Exact flags evolve with releases. Use the installed CLI help or product repository for the normative reference.
These adoption guides are maintained by the website team. Read the normative product documentation →