Supercheck

Global Flags

These flags are available on all commands:

Flag	Description
`--json`	Output in JSON format (for CI/CD scripting)
`--quiet`	Suppress non-essential output (only IDs and errors)
`--debug`	Enable debug logging
`-v`	Show version

Config-aware commands (for example config, diff, deploy, pull, validate, destroy) accept --config <path> to point at a specific config file.

Exit Codes

Code	Meaning	Example
`0`	Success	Job completed successfully
`1`	General error	Test failed, monitor down
`2`	Authentication error	Invalid token, expired token
`3`	Configuration error	Missing config, invalid schema
`4`	Network / API error	API unreachable, 5xx response
`5`	Timeout	Operation exceeded timeout

Authentication

Authenticate with a CLI token.

supercheck login --token <token>
supercheck login --token <token> --url https://supercheck.yourdomain.com

Flag	Required	Description
`--token <token>`	Yes	CLI token (`sck_live_*`)
`--url <url>`	No	API base URL for self-hosted

The token is verified against the API before being stored locally.

`supercheck whoami`

Display the current authentication context.

supercheck whoami

Shows token name, user, project, organization, and expiry.

`supercheck logout`

Clear stored credentials.

supercheck logout

Configuration

`supercheck init`

Initialize a new project with supercheck.config.ts and _supercheck_/ folder.

supercheck init
supercheck init --force              # Overwrite existing config
supercheck init --skip-install       # Skip dependency installation
supercheck init --skip-examples      # Skip example test files
supercheck init --pm pnpm            # Use specific package manager

Flag	Description
`--force`	Overwrite existing config files
`--skip-install`	Skip automatic dependency installation
`--skip-examples`	Skip generating example test files
`--pm <manager>`	Package manager to use (`npm`, `pnpm`, `yarn`, `bun`)

`supercheck config validate`

Validate the configuration file schema.

supercheck config validate

`supercheck validate`

Validate local test scripts using the same rules as Playground.

supercheck validate

`supercheck config print`

Print the resolved configuration with environment variable expansion.

supercheck config print

Jobs

`supercheck job list`

List all jobs in the current project.

supercheck job list
supercheck job list --page 2 --limit 10

Flag	Default	Description
`--page`	`1`	Page number
`--limit`	`50`	Items per page

`supercheck job get`

Get job details.

supercheck job get <job-id>

`supercheck job create`

Create a new job.

supercheck job create --name "Nightly E2E" --tests <test-id> --schedule "0 2 * * *"
supercheck job create --name "Smoke Tests" --tests id1,id2 --type k6 --dry-run

Flag	Required	Description
`--name`	Yes	Job name
`--tests`	Yes	Test IDs (space or comma separated)
`--description`	No	Job description
`--type`	No	Job runner type: `playwright` (default) or `k6`
`--schedule`	No	Cron expression
`--dry-run`	No	Preview what would be sent without creating

Job --type selects the runner. Test --type uses API types: browser, performance, api, database, custom.

`supercheck job update`

Update job configuration.

supercheck job update <job-id> --name "Updated Name"
supercheck job update <job-id> --schedule "0 3 * * *" --dry-run

Flag	Description
`--name`	Job name
`--description`	Job description
`--schedule`	Cron expression
`--dry-run`	Preview what would be sent without updating

Job status is runtime state, not configuration. Use job run, job trigger, or the dashboard/scheduler to affect execution state.

`supercheck job delete`

Delete a job with confirmation.

supercheck job delete <job-id>
supercheck job delete <job-id> --force    # Skip confirmation

`supercheck job run`

Run a job immediately, bypassing the cron schedule.

supercheck job run --id <job-id>
supercheck job run --local --id <job-id>     # Run locally
supercheck job run --cloud --id <job-id>     # Run in the cloud

`supercheck job trigger`

Trigger a job and optionally wait for completion.

supercheck job trigger <job-id>
supercheck job trigger <job-id> --wait --timeout 300
supercheck job trigger <job-id> --wait --json

Flag	Description
`--wait`	Wait for the run to complete
`--timeout`	Maximum wait time in seconds (default: 300)

supercheck job trigger requires SUPERCHECK_TRIGGER_KEY. If you also use --wait, set SUPERCHECK_TOKEN so the CLI can poll the run after triggering it.

`supercheck job keys`

Manage trigger keys for a job.

# List keys for a job
supercheck job keys <job-id>

# Create a new trigger key
supercheck job keys create <job-id> --name "CI Trigger"
supercheck job keys create <job-id> --name "Temp Key" --expires-in 86400

# Revoke a trigger key
supercheck job keys delete <job-id> <key-id>

Runs

`supercheck run list`

List job runs with optional filters.

supercheck run list
supercheck run list --job <job-id> --status failed --limit 20

Flag	Description
`--page`	Page number
`--limit`	Items per page
`--job`	Filter by job ID
`--status`	Filter by status (`queued`, `running`, `passed`, `failed`, `error`, `blocked`)

`supercheck run get`

Get run details.

supercheck run get <run-id>

`supercheck run permissions`

Get run access permissions.

supercheck run permissions <run-id>

`supercheck run status`

Quick status check for a run.

supercheck run status <run-id>

`supercheck run stream`

Stream live console output from a running execution via SSE.

supercheck run stream <run-id>
supercheck run stream <run-id> --idle-timeout 120

Flag	Default	Description
`--idle-timeout`	`60`	Seconds to wait before timing out if no data received (min: 10)

`supercheck run cancel`

Cancel a running execution.

supercheck run cancel <run-id>

Tests

`supercheck test list`

List tests with optional search and type filters.

supercheck test list
supercheck test list --search "checkout" --type browser

Flag	Description
`--page`	Page number
`--limit`	Items per page
`--search`	Search by title
`--type`	Filter by type (`browser`, `performance`, `api`, `database`, `custom`)

`supercheck test get`

Get test details.

supercheck test get <test-id>
supercheck test get <test-id> --include-script

`supercheck test create`

Create a new test from a script file.

supercheck test create --title "Homepage Check" --file ./_supercheck_/playwright/homepage-check.<id>.pw.ts --type browser

Flag	Required	Description
`--title`	Yes	Test title
`--file`	Yes	Path to test script
`--type`	No	`browser`, `performance`, `api`, `database`, `custom`
`--description`	No	Test description
`--dry-run`	No	Preview what would be sent without creating

`supercheck test update`

Update a test.

supercheck test update <test-id> --title "Updated Title" --file ./updated-script.pw.ts
supercheck test update <test-id> --type api --dry-run
supercheck test update <test-id> --description "New description" --dry-run

Flag	Description
`--title`	Test title
`--file`	Path to updated test script
`--type`	Test type (`browser`, `performance`, `api`, `database`, `custom`)
`--description`	Test description
`--dry-run`	Preview what would be sent without updating

`supercheck test delete`

Delete a test with confirmation.

supercheck test delete <test-id>
supercheck test delete <test-id> --force

Use supercheck test run --file <path> for local execution, or supercheck job trigger <id> for cloud execution.

`supercheck test tags`

List tags for a test.

supercheck test tags <test-id>

`supercheck test validate`

Validate a test script without creating it.

supercheck test validate --file ./_supercheck_/playwright/homepage-check.<id>.pw.ts --type browser

`supercheck test run`

Run tests locally.

supercheck test run --file ./_supercheck_/playwright/homepage-check.<id>.pw.ts
supercheck test run --all --type browser
supercheck test run --all --type performance

Flag	Description
`--file`	Path to a local test file to run
`--all`	Run all local tests
`--type`	Filter by test type (`browser`, `performance`, `api`, `database`, `custom`)

`supercheck test status`

Stream live status events for a test.

supercheck test status <test-id>
supercheck test status <test-id> --idle-timeout 120

Flag	Default	Description
`--idle-timeout`	`60`	Seconds to wait before timing out if no data received (min: 10)

Monitors

`supercheck monitor list`

List all monitors.

supercheck monitor list
supercheck monitor list --page 2 --limit 10

`supercheck monitor get`

Get monitor details.

supercheck monitor get <monitor-id>

`supercheck monitor status`

Get current monitor status (quick view).

supercheck monitor status <monitor-id>

`supercheck monitor results`

Get recent check results.

supercheck monitor results <monitor-id>
supercheck monitor results <monitor-id> --page 2 --limit 20

Flag	Default	Description
`--page`	`1`	Page number
`--limit`	`20`	Results per page

`supercheck monitor stats`

Get performance statistics.

supercheck monitor stats <monitor-id>

`supercheck monitor create`

Create a new monitor.

supercheck monitor create --name "API Health" --url https://api.example.com/health --type http_request --interval-minutes 5
supercheck monitor create --name "Website" --url https://example.com --dry-run

Flag	Required	Default	Description
`--name`	Yes	—	Monitor name
`--url`	Yes	—	URL to monitor
`--type`	No	`http_request`	`http_request`, `website`, `ping_host`, `port_check`, `synthetic_test`
`--interval-minutes`	No	`5`	Check interval in minutes (1–1440)
`--timeout`	No	`30`	Request timeout in seconds
`--method`	No	`GET`	HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS`)
`--dry-run`	No	—	Preview what would be sent without creating

The --interval flag (seconds) is deprecated. Use --interval-minutes instead.

`supercheck monitor update`

Update a monitor.

supercheck monitor update <monitor-id> --interval-minutes 1 --active false
supercheck monitor update <monitor-id> --name "Updated" --method POST --dry-run

Flag	Description
`--name`	Monitor name
`--url`	URL to monitor
`--interval-minutes`	Check interval in minutes (1–1440)
`--timeout`	Request timeout in seconds
`--method`	HTTP method
`--active`	Enable or disable (`true`/`false`)
`--dry-run`	Preview what would be sent without updating

The --interval flag (seconds) is deprecated. Use --interval-minutes instead.

`supercheck monitor delete`

Delete a monitor with confirmation.

supercheck monitor delete <monitor-id>
supercheck monitor delete <monitor-id> --force

Variables

`supercheck var list`

List project variables.

supercheck var list

`supercheck var get`

Get a variable by key name.

supercheck var get <key>

`supercheck var set`

Create or update a variable.

supercheck var set <key> <value>
supercheck var set API_KEY sk-secret-value --secret
printf '%s' \"$API_KEY\" | supercheck var set API_KEY --secret --value-stdin
supercheck var set DB_URL postgres://... --description "Database connection string"

Flag	Description
`--secret`	Mark as secret (value will be encrypted)
`--value-stdin`	Read the value from stdin instead of the command line
`--description`	Variable description

Prefer --value-stdin for secrets so they do not end up in shell history or process arguments.

`supercheck var delete`

Delete a variable by key name.

supercheck var delete <key>
supercheck var delete <key> --force

Flag	Description
`--force`	Skip confirmation

Flag	Description
`--force`	Skip confirmation prompt

Notification Providers

`supercheck notification list`

List notification providers.

supercheck notification list

`supercheck notification get`

Get provider details.

supercheck notification get <id>

`supercheck notification create`

Create a notification provider.

supercheck notification create --type slack --name "Slack Alerts" \
  --config '{"webhookUrl":"https://hooks.slack.com/..."}'

Flag	Required	Description
`--type`	Yes	`email`, `slack`, `webhook`, `telegram`, `discord`, `teams`
`--name`	Yes	Provider name
`--config`	No	JSON configuration string

`supercheck notification update`

Update a notification provider.

supercheck notification update <id> --name "Updated Name" --config '{...}'
supercheck notification update <id> --type webhook --config '{...}'

Flag	Description
`--name`	Provider name
`--type`	Provider type
`--config`	JSON configuration string (replaces entire config — include all fields)

When a provider has secret fields (for example webhook URLs or API keys), the CLI never merges your input with masked values from the server. If you omit --config, only --name and --type are updated and existing secrets are preserved.

`supercheck notification delete`

Delete a notification provider.

supercheck notification delete <id>
supercheck notification delete <id> --force

`supercheck notification test`

Send a test notification to verify configuration.

supercheck notification test --type slack --config '{"webhookUrl":"https://hooks.slack.com/..."}'

Flag	Required	Description
`--type`	Yes	Provider type (`email`, `slack`, `webhook`, `telegram`, `discord`, `teams`)
`--config`	Yes	JSON configuration string

Alerts & Audit

`supercheck alert history`

View alert history.

supercheck alert history
supercheck alert history --page 2 --limit 20

Flag	Default	Description
`--page`	`1`	Page number
`--limit`	`50`	Results per page

`supercheck audit`

View audit logs (admin only).

supercheck audit
supercheck audit --page 2 --limit 50 --action "notification_provider_created"
supercheck audit --search "deploy"

Flag	Default	Description
`--page`	`1`	Page number
`--limit`	`20`	Items per page
`--search`	—	Search by action
`--action`	—	Filter by action type

Monitoring-as-Code

`supercheck pull`

Pull remote resources into local config and files. Config pulls include monitors, jobs, notification providers, variables, tags, and status pages; test pulls also write test scripts under _supercheck_/.

supercheck pull
supercheck pull --dry-run
supercheck pull --force
supercheck pull --tests-only
supercheck pull --config-only

`supercheck diff`

Preview changes between local config and server state. Notification provider changes include nested config fields such as webhook bodyTemplate.

supercheck diff

`supercheck deploy`

Push configuration to the Supercheck API, including notification provider config and webhook body templates.

supercheck deploy
supercheck deploy --dry-run      # Preview without applying
supercheck deploy --no-delete    # Skip deletions
supercheck deploy --force        # Skip confirmation

`supercheck destroy`

Tear down all managed resources defined with IDs in the local config, including notification providers.

supercheck destroy
supercheck destroy --dry-run
supercheck destroy --force

Utilities

`supercheck health`

Check API health.

supercheck health
supercheck health --url https://supercheck.yourdomain.com

`supercheck locations`

List available execution locations.

supercheck locations

`supercheck upgrade`

Upgrade the CLI to the latest release.

supercheck upgrade
supercheck upgrade --tag 0.1.1-rc.2      # Install a specific version
supercheck upgrade --package-manager pnpm  # Use specific package manager
supercheck upgrade --dry-run               # Preview without installing
supercheck upgrade -y                      # Skip confirmation

Flag	Description
`--tag <tag>`	Release target to install (default: `latest`, accepts explicit versions)
`--package-manager <pm>`	Package manager to use (`npm`, `pnpm`, `yarn`, `bun`)
`-y, --yes`	Skip confirmation prompt
`--dry-run`	Preview the upgrade command without executing

`supercheck doctor`

Check that all dependencies and configuration are set up correctly.

supercheck doctor
supercheck doctor --fix    # Attempt to automatically install missing dependencies

The doctor command checks:

Node.js — runtime availability
@playwright/test — npm package for browser tests
Playwright browsers — chromium binary for local test execution
k6 — binary for performance/load tests (optional)
Authentication — whether a valid token is stored
Configuration — whether supercheck.config.ts exists and is valid

Command Reference

On this page