Supercheck

Install via npm

# Global install (recommended)
npm install -g @supercheck/cli

# Or run without installing
npx @supercheck/cli health

Requires Node.js 18 or later.

Verify Installation

supercheck --version
supercheck health

Docker

Run the CLI in a container using the official Node.js image:

docker run --rm \
  -e SUPERCHECK_TRIGGER_KEY=$SUPERCHECK_TRIGGER_KEY \
  -e SUPERCHECK_TOKEN=$SUPERCHECK_TOKEN \
  node:20-slim sh -c "npm install -g @supercheck/cli && supercheck job trigger <job-id> --wait"

See CI/CD Integration for Docker-based pipeline examples.

Authenticate

The CLI requires a CLI token for API access. Create one in the dashboard:

Go to Project Settings → CLI Tokens
Click Create Token
Copy the token (shown only once)

Then authenticate:

# Option 1: Environment variable (recommended for CI/CD)
export SUPERCHECK_TOKEN="sck_live_..."
supercheck login --token $SUPERCHECK_TOKEN

# Option 2: Direct login
supercheck login --token sck_live_a1b2c3d4...

supercheck job trigger uses SUPERCHECK_TRIGGER_KEY, not the CLI token. Add SUPERCHECK_TOKEN only when you also use --wait or other API commands.

Self-Hosted Setup

Point the CLI at your self-hosted instance:

export SUPERCHECK_URL="https://supercheck.yourdomain.com"
export SUPERCHECK_TOKEN="sck_live_..."

supercheck login --token $SUPERCHECK_TOKEN --url $SUPERCHECK_URL
supercheck health

Standard Supercheck self-hosted deployments use Traefik + Let's Encrypt for automatic TLS — no certificate configuration required.

Proxy Configuration

For corporate networks, the CLI respects standard proxy environment variables:

export HTTPS_PROXY="http://proxy.corp.com:8080"
export NO_PROXY="localhost,127.0.0.1,.internal.corp.com"
export SUPERCHECK_TRIGGER_KEY="sck_trigger_..."
export SUPERCHECK_TOKEN="sck_live_..."
supercheck job trigger <id> --wait

Initialize a Project

Scaffold a new supercheck.config.ts and _supercheck_/ folder:

supercheck init

This creates:

my-project/
├── _supercheck_/
│   ├── playwright/   # Playwright test files
│   └── k6/           # k6 performance tests
└── supercheck.config.ts

The init command automatically:

Installs @playwright/test and @types/k6 as dev dependencies
Downloads the Playwright chromium browser binary for local test execution
Warns if k6 is not installed (needed for performance tests)

Test Dependencies

Playwright (Browser Tests)

supercheck init handles Playwright setup automatically. If you need to install manually:

npm install --save-dev @playwright/test
npx playwright install chromium

k6 (Performance Tests)

k6 is a standalone binary — install it via your system package manager:

# macOS
brew install k6

# Linux (snap)
sudo snap install k6

# Windows
choco install k6
# or
winget install k6

See k6 installation docs for more options.

Verify Dependencies

Run the doctor command to check that everything is set up:

supercheck doctor

Uninstall

# Clear stored credentials first
supercheck logout

# Remove global install
npm uninstall -g @supercheck/cli

Installation

On this page