Docs · Reference
CLI commands.
The 11 commands, generated from the --help of the published package. Exit codes : 0 success · 1 gaps · 2 missing prerequisite.
Global flags
| Option | What it does |
|---|---|
-V, --version | output the version number |
--no-color | disable colored output |
--verbose | detailed logs |
--yes | non-interactive: accept all defaults (CI) |
--dry-run | print planned actions without writing |
init [options] | scaffold the mission structure (interactive wizard, or --yes) |
check [options] | can I cross the gate — gate audit, exit 1 on gaps (CI-friendly) |
status [options] | where am I — mission snapshot: current gate, decision journal, workflows |
doctor | environment and installation checks |
wire [options] | recommend the auto-trigger channel for the AI harness running this command (read-only; never wires — the operator does, ADR-0012) |
update [options] | refresh runward/workflows/ and runward/rules/ from this package version (mission state untouched) |
characterize [options] | read-only inventory of an existing codebase → runward/characterization.md (brownfield/retro-doc) |
manifest [options] | rule-conformance manifest overview; --sync scaffolds missing rows and migrates renamed slugs (form only, never content) |
rules [options] | the effective rule set (mission copy, else package); --json is a stable machine contract |
explain [options] <rule> | print a rule's contract (impact, phases, why, signature) and its full text — the rationale inline |
compliance [options] [regime] | assemble a regime-framed evidence pack from the mission (deterministic, read-only; a readiness draft, never a compliance claim) |
help [command] | display help for command |
runward init
scaffold the mission structure (interactive wizard, or --yes)
runward init [options]
| Option | What it does |
|---|---|
-p, --path <path> | project directory (default: prompt, or . with --yes) |
-t, --tools <list> | comma-separated tool profiles: claude,cursor,copilot,gemini,windsurf,continue,junie,trae,kiro |
--force | overwrite existing files |
--example | scaffold a filled reference mission (request-triage) — the whole chain is green out of the box |
runward check
can I cross the gate — gate audit, exit 1 on gaps (CI-friendly)
runward check [options]
| Option | What it does |
|---|---|
-p, --path <path> | project directory |
--strict | also verify the rule-conformance manifests: rows, typed pointers, signatures, drift, seal (deterministic) |
--freeze | seal a green strict gate: hash the evidence into runward/evidence-lock.json (implies --strict) |
--hooks | run operator hooks from runward/hooks.json around the audit (opt-in) |
--coverage | advisory: report deliverable + decision-ratification coverage (does not gate) |
--json | machine output: verdict, current gate, deliverable states, conformance gaps (stable contract, for agent-driven runs) |
runward status
where am I — mission snapshot: current gate, decision journal, workflows
runward status [options]
| Option | What it does |
|---|---|
-p, --path <path> | project directory |
runward doctor
environment and installation checks
runward doctor [options]
runward wire
recommend the auto-trigger channel for the AI harness running this command (read-only; never wires — the operator does, ADR-0012)
runward wire [options]
| Option | What it does |
|---|---|
-p, --path <path> | project directory |
--json | machine output: detection status, harness, recommended + candidate channels (stable contract) |
runward update
refresh runward/workflows/ and runward/rules/ from this package version (mission state untouched)
runward update [options]
| Option | What it does |
|---|---|
-p, --path <path> | project directory |
--force | overwrite locally modified workflows |
runward characterize
read-only inventory of an existing codebase → runward/characterization.md (brownfield/retro-doc)
runward characterize [options]
| Option | What it does |
|---|---|
-p, --path <path> | project directory (default: .) |
--mine | also propose candidate retroactive ADRs as DRAFT hypotheses (deterministic git archaeology, no model call) |
runward manifest
rule-conformance manifest overview; --sync scaffolds missing rows and migrates renamed slugs (form only, never content)
runward manifest [options]
| Option | What it does |
|---|---|
-p, --path <path> | project directory |
--sync | write: append missing rows with an empty status, rewrite renamed slugs, create missing sections |
runward rules
the effective rule set (mission copy, else package); --json is a stable machine contract
runward rules [options]
| Option | What it does |
|---|---|
-p, --path <path> | project directory |
--json | machine output: { runward, source, count, rules } sorted by slug (versioned, additive) |
--phase <id> | only the rules mapped to this phase (architect | topology | floor | govern) |
runward explain
print a rule's contract (impact, phases, why, signature) and its full text — the rationale inline
runward explain [options] <rule>
| Option | What it does |
|---|---|
-p, --path <path> | project directory |
--json | machine output: the rule plus its body |
runward compliance
assemble a regime-framed evidence pack from the mission (deterministic, read-only; a readiness draft, never a compliance claim)
runward compliance [options] [regime]
| Option | What it does |
|---|---|
-p, --path <path> | project directory |
--regime-version <version> | regime mapping version (default: highest shipped, see regimes/) |
Generated from runward --help / runward <command> --help · runward v0.22.0