Quickstart

Configure one organization, connect a browser product, and ask Proof to exercise a customer task.

Before you start

You need the Proof base URL, an organization-scoped machine API key, a connected repository ID, and a browser-accessible base URL. An administrator can create the key and find repository context in the Proof dashboard.

Activation is separate from configuration

A configured client can reach Proof, but runs still fail closed while live execution is paused. This lets a team finish account setup without accidentally creating Vercel or model-provider spend.

Configure the CLI

Build or install the Proof CLI, then save your defaults. The configuration file is written with user-only permissions at ~/.config/proof/config.json.

bash

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

Run a customer task

Describe the outcome and the edge case in the language a QA engineer would use. Proof will interpret the task against the selected product.

bash

proof run "Complete checkout with a declined card and confirm no order is created"

To replay an existing catalog item without restating it, pass its scenario ID:

bash

proof run --scenario scenario_checkout_declined_card

Read the result

The command streams durable status updates until the run reaches a terminal state. It then prints the run ID and dashboard link. Exit code 0 means passed or healed, 2 means the run completed with a non-passing product outcome, and 1 means configuration, transport, or command failure.

Continue with the complete CLI reference or learn how to inspect the same run in the web dashboard.