Environment Configuration

Checksum supports multiple testing environments, each with its own environment URL, credentials, and configuration. This allows you to test against staging, production, or any other environment.

For setting up your repository connections (test repo vs code repo), see Repo & CLI Setup.

---

Managing Environments

Each environment has:

• Name — A label for the environment (e.g., “Staging”, “Production”)
• Environment URL — The application URL for this environment
• Login URL — The login page URL (if authentication is required)

To add or edit environments, go to Settings → Testing Environment.

---

Test Users

Test users are the credentials Checksum uses to log into your application. Each environment can have multiple users for testing different roles or permission levels.

To add a user:

1. Go to Settings → Testing Environment
2. Select the environment
3. Click Add User
4. Enter the username and password

These credentials are stored securely and are only used during test execution.

You can also add custom environment variables in the Checksum web app under Settings → Testing Environment. Any variables you add will be included in the .env file when downloaded via the CLI. This is useful for API keys, feature flags, or any other configuration your tests need.

---

Environment Variables

The Checksum CLI downloads environment variables from your project settings using the following command. You can find your API key on the Project Settings tab.

npx checksumai dotenv --download --api-key=<YOUR_API_KEY>

This creates a .env file in your test repository with all configured variables. You can override any variable by setting it explicitly in your CI environment or local shell:

# Override environment URL for local testing
BASE_URL=http://localhost:3000 npx checksumai test

In CI, set overrides as environment variables or secrets:

env:
  CHECKSUM_API_KEY: ${{ secrets.CHECKSUM_API_KEY }}
  BASE_URL: ${{ secrets.BASE_URL }}
  USERNAME: ${{ secrets.USERNAME }}
  PASSWORD: ${{ secrets.PASSWORD }}

Variables set explicitly always take precedence over the downloaded .env file.