Proof Docs

Command line

Configure defaults once, start natural-language or catalog runs, stream durable progress, and inspect results from scripts or a terminal.

proof configure

Saves the API URL, organization-scoped API key, repository ID, and browser target. Pass only the values you want to change; existing values are preserved.

bash
proof configure --api-url https://proof.example.com --api-key "$PROOF_API_KEY" --repository repo_storefront --base-url https://storefront.example.com

The API key determines the organization. The CLI cannot override tenant scope.

Set PROOF_CONFIG to use a different configuration file. The default file is ~/.config/proof/config.json.

proof run

bash
proof run "Create an account with an already-used email and confirm no duplicate user is created"

Use --scenario for a known catalog scenario:

bash
proof run --scenario scenario_duplicate_email --json

Run options

OptionBehavior
--repositoryOverride the configured repository ID.
--base-urlOverride the configured browser target.
--commit-shaRun against a specific commit of at least seven characters.
--scenarioReplay a catalog scenario instead of a natural-language task.
--no-waitPrint the new run ID immediately instead of streaming progress.
--jsonWrite machine-readable JSON and keep progress off stdout.
--timeoutMaximum wait in seconds; defaults to 1,800 and caps at 7,200.

proof status

Fetch the durable run view as formatted JSON, including the run, timeline events, safe artifact metadata, and reports.

bash
proof status run_abc123

Use the CLI in automation

Pass --json so stdout contains one JSON object. Exit code 0 indicates passed or healed, 2 indicates a completed non-passing outcome, and 1 indicates a CLI or transport failure.