Proof Docs

Command line

Set defaults once, start Jobs, follow progress, and inspect results from a script or terminal.

proof configure

Saves the API URL, organization API key, project ID, and browser target. Pass only values you want to change. Existing values stay the same.

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

The API key determines the organization. The CLI cannot change that organization.

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

proof job

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

Use --test for a known saved test:

bash
proof job --test test_duplicate_email --json

Job options

OptionBehavior
--projectOverride the configured project ID.
--base-urlOverride the configured browser target.
--commit-shaJob against a specific commit of at least seven characters.
--testReplay a saved test 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

Get the Job as formatted JSON. It includes the Job, timeline events, safe artifact details, and Findings.

bash
proof status run_abc123

Use the CLI in automation

Pass --json so stdout contains one JSON object. Exit code 0 means passed or healed. Exit code 2 means the expected outcome did not pass. Exit code 1 means a CLI or connection problem.