Skip to main content
For the full repository initialization guide (creating a test repo, running npx checksumai init, folder structure, and configuration), see Repo & CLI Setup.

​
Installation

The CLI is included as an npm dependency in your Checksum test repository. After cloning your test repo:

​
Authentication

Download your project’s environment variables using your API key:
This creates a .env file with your configured environment settings (environment URL, login URL, credentials, etc.). You can find your API key in Settings → Project Settings in the web app.

​
Running Tests

​
Run all tests

​
Run specific tests by name

​
Verify setup with the example test

The “example” test is a special quick test that validates your login process works correctly. Run it first to confirm everything is set up.

​
Test Run Modes

​
Environment Variables

The CLI uses environment variables from the downloaded .env file. You can override any variable:

​
Configuration

Your test setup is configured in checksum.config.ts inside the checksum/ directory. Key options include: For the full configuration reference, see Repo & CLI Setup.
Explicit environment variables always take precedence over the .env file.

​
What the CLI Uploads

After each test run, the CLI uploads results to the Checksum dashboard when hostReports is enabled in checksum.config.ts. By default, this is true when CI=true (which is set automatically by most CI providers). For local runs, reports are saved locally only unless you explicitly enable hostReports. When uploading is enabled, the CLI sends:
  • Test results — pass/fail/healed status for each test
  • Videos — screen recordings of test execution
  • Screenshots — captured at key points and on failures
  • HAR files — network traffic recordings
  • Playwright traces — detailed execution traces for debugging
These artifacts are available in the web app under Test Results. See Reports and Traces for details.

​
Next Steps