CLI Commands (Curated Guide)

Canonical CLI help lives in generated reference:

• apps/archkit-cli/generated/persistent/docs/cli-reference.md

Use this page for navigation + policy, not copied help text.

Ownership model

• Generated command details: gen_docs output (cli-reference.md)
• Curated/operator guidance: this page + adjacent reference docs
• Drift rule: do not duplicate full --help blocks here

Common flows

• Parse/validate/view: archkit parse, archkit validate, archkit view
• Batch operations: archkit validate-all, archkit view-all, archkit index
• Project management: archkit project <subcommand> (init, index, layout-check, tag, note, dogfood, check, mirror, drift, promote, verify)
• Docs pipeline: archkit docgen
• Type model workflows: archkit type-model <subcommand>
• Snapshot lifecycle: archkit snapshot <subcommand>

Project Init Configuration

The archkit project init command is configurable via CLI flags:

archkit project init --root <dir> --name <name> \
  [--version <version>] \
  [--description <description>] \
  [--overlay <overlay>...]

• --root - Project root directory (default: .)
• --name - Project name (required if not inferring from –root)
• --version - Semantic version for archkit.project.toml (default: v0)
• --description - Optional project description
• --overlay - Custom overlay file stems (repeatable; when provided, replaces defaults)

Configuration is persisted in archkit.project.toml under [init]. Re-running init on an existing project is idempotent and respects saved configuration as defaults.

Feature-gated commands

See generated matrix:

• apps/archkit-cli/generated/persistent/docs/feature-command-matrix.md

Quick start

archkit --help
archkit <command> --help

For full command tree coverage, rely on generated cli-reference.md only.