Docs / Platform
CLI reference
Everything in Invariant can be done from the command line. The CLI is also how CI systems and coding agents integrate.
Design preview. These docs describe how Invariant is being built. Commands, output and limits are illustrative until release, and stage tags mark what ships first. See the roadmap.
Commands
| Command | What it does | Status |
|---|---|---|
invariant init | Detect your stack and write a starter invariant.yaml | MVP |
invariant doctor | Check Docker, GPUs, credentials and runner capabilities on this machine | MVP |
invariant login | Authenticate with the control plane (not needed for local-only use) | MVP |
invariant run <suite> | Run a suite and print verdicts | MVP |
invariant scenario add | Add a scenario, for example from a log slice | MVP |
invariant scenario ls | List scenarios, versions and latest results | MVP |
invariant compare <run> <run> | Compare two existing runs or suite results without re-running | MVP |
invariant open <run> | Open a run or suite report in the browser | MVP |
invariant export <run> | Export run records and results as JSON, CSV or MCAP | MVP |
invariant runner register | Turn this machine into a runner for your organization | MVP |
invariant replay <run> | Reconstruct one run locally from its run record, within simulator and hardware reproducibility limits | Next |
invariant plan <suite> | Estimate run counts, time and cost before running | Next |
invariant bisect | Find the first commit where a scenario got worse | Next |
invariant mcp | Start the MCP server for coding agents | Next |
invariant run
invariant run <suite> [--compare REF] [--scenario PATTERN] [--runs N]
[--where local|cloud|runner:LABEL] [--budget-gpu-hours N]
[--strict] [--summary FILE] [--json]| Flag | Description |
|---|---|
--compare REF | Baseline git ref or run ID. Defaults to the suite's configured baseline, usually main. |
--scenario PATTERN | Run only matching scenarios, for example dock_*. |
--runs N | Override the starting number of paired runs. |
--where | Where to run. local is the default when not logged in. |
--strict | Treat inconclusive and flaky as blocking. |
--summary FILE | Write a Markdown summary for CI. |
--json | Machine-readable output for scripts and agents. |
Exit codes are listed in CI and workflows.