Installation
Install and set up the Supercheck CLIEdit
Requires Node.js 20 or later.
Install
# Global install (recommended)
npm install -g @supercheck/cli
# Or run without installing
npx @supercheck/cli healthVerify
supercheck --version
supercheck healthSign in
supercheck loginApprove the code in your browser. To use a token instead, create one under Organization → CLI Tokens → Create Token (shown only once) and pass it:
supercheck login --token sck_live_a1b2c3d4...In CI/CD no login step is needed. Export the token and the CLI reads it at runtime:
export SUPERCHECK_TOKEN="sck_live_..."Initialize a project
supercheck initsupercheck job trigger uses SUPERCHECK_TRIGGER_KEY, not the CLI token. Add SUPERCHECK_TOKEN only when you also use --wait or other API commands.
Local test execution does not require a Supercheck account: supercheck test run --offline --file <path> or supercheck job run --id <name-or-id> --local --offline use local Playwright/k6 dependencies and skip server validation. Cloud commands still require credentials. For agent setup, see Agent Quickstart.
What init Creates
my-project/
├── _supercheck_/
│ ├── playwright/ # Playwright test files
│ └── k6/ # k6 performance tests
└── supercheck.config.tsinit also installs @playwright/test and @types/k6 as dev dependencies, downloads the Playwright chromium browser for local execution, and warns if k6 is not installed (needed for performance tests).
Test Dependencies
| Dependency | Needed for | Install |
|---|---|---|
@playwright/test and chromium | Browser and API tests | Handled by supercheck init, or npm install --save-dev @playwright/test && npx playwright install chromium |
| k6 | Performance tests | macOS brew install k6; Linux sudo snap install k6; Windows choco install k6 or winget install k6 (more options) |
Check everything with supercheck doctor.
Docker
Set SUPERCHECK_JOB_ID and both tokens in your environment, then run the CLI using the official Node.js image:
docker run --rm \
-e SUPERCHECK_TRIGGER_KEY -e SUPERCHECK_TOKEN -e SUPERCHECK_JOB_ID \
node:20-slim sh -c 'npm install -g @supercheck/cli && supercheck job trigger "$SUPERCHECK_JOB_ID" --wait'See CI/CD Integration for Docker-based pipeline examples.