The documentation build generates this page from _data/cli-surface.json. Maintainers compare the manifest with the package CLI implementation.

Commands

Command Input Options JSON fields
validate Starting State file or - --changes, --generator, --constraints, --time, --seed, --max-events, --custom, --custom-catalog, --json, --fail-on-warning, --yes validation, run, problems
snapshot Starting State file or - --changes, --generator, --time, --seed, --max-events, --json time, time_minutes, seed, run, state, problems
constraints Starting State file or - --constraints, --changes, --generator, --time, --seed, --max-events, --json, --yes time, seed, run, violations, problems
render Starting State file or - Project, asset, runtime, output, and JSON options time, time_minutes, seed, output, svg, run, problems
format JSON file --write, --out None
migrate Historical JSON file --out, --schema None

Global options

Syntax Effect
-h, --help Show help.
-v, --version, version Print the installed package version.

Exit codes

Code Meaning
0 The command completed without an error result.
1 A validation, runtime, migration, or Constraint result contains an error.
2 CLI usage, confirmation, input, parsing, rendering, or output handling failed.

See exit codes and failure policy for command-specific details.