Skip to main content
Derived from apps/cli/src/index.ts. Add --json to any command for machine-readable output — this is what an agent should always do. Add --session <id> to act on a specific local report instead of the current one.

Global options

Exit codes

Effort shortcuts

Each is equivalent to session start --effort <effort> and takes the same flags: See Effort modes.

session

phase

Valid phases: preflight, scope, discovery, source_review, runtime_validation, access_control, validation, reporting. An unknown phase is an error naming the valid set.

target

Exit code 3 on denial. See Authorization and safety.

action check

--intent is required and should be short and machine-readable, such as read_order_as_other_identity. --repeat feeds mass-mutation detection. --disposable declares the target a machine-local disposable fixture. Exit code 4 when the action is prohibited.

finding

See Finding schema.

note

coverage records something that was assessed; limitation records something that was not or could not be assessed.

metrics token

--source is required. Use estimated with an --estimator name and version, or unavailable when the host cannot report usage. Never state an exact count that did not come from the host.

fix

fix record requires exactly one of --applied, --verified, --verification-failed, or --reverted. See Fix and retest.

Account and device

logout is confirmation-gated, so in a non-interactive shell it reports “Left unchanged” and removes nothing. Run it in a real terminal.

Project and reports

workspace --set and workspace --detach are also confirmation-gated.

update

Verifies and stages a signed update. --apply downloads and verifies the artifact. Clients verify the ed25519 signature against a pinned public key, check the artifact digest and size, and refuse downgrades, stale manifests, and revoked versions before anything is written to disk.

Environment variables

Every variable the CLI, the web app, and the worker read.

Error codes

Stable API error codes and their HTTP statuses.