CLI Overview
Open-source testing, monitoring, and AI SRE — as code with the Supercheck CLIEdit
The Supercheck CLI (@supercheck/cli) runs your tests, monitors, jobs and incident workflows from the terminal, CI/CD pipelines and coding agents. See the package on npm.
Agent guidance
Versioned workflows offline with supercheck skills; config schema with supercheck schema config --json
Offline local execution
Run Playwright and k6 tests with no account or server validation
CI/CD
Trigger jobs, wait for results, gate deployments
Monitoring-as-Code
Define monitors, tests (with priority and tags), jobs, requirements, notification providers, variables, tags and status pages in supercheck.config.ts
AI SRE
Triage incidents, start investigations, stream Copilot answers, inspect service dependencies
Scriptable output
--json on every command, with automatic retry of safe requests
Quick Start
Install
npm install -g @supercheck/cliSign in
supercheck loginApprove the code in your browser. Or pass a CLI token: supercheck login --token sck_live_...
Verify and explore
supercheck whoami
supercheck health
supercheck job list
supercheck monitor list
supercheck test listInvestigate incidents
supercheck incident list
supercheck sre ask "Summarize active reliability risks"Choose Your Credential
Most commands use a CLI token (sck_live_*). supercheck job trigger is the exception: it uses a job-specific trigger key (sck_trigger_*), plus a CLI token only when you add --wait.
| Use case | Credential | Variable |
|---|---|---|
Most commands, deploy, diff, whoami | CLI token | SUPERCHECK_TOKEN |
job trigger | Trigger key | SUPERCHECK_TRIGGER_KEY |
job trigger --wait | Trigger key and CLI token | both |
Local runs (--offline) | None | — |
Agent Workflows
| Command | Purpose |
|---|---|
supercheck skills [topic] | Workflow index, or focused guidance: onboarding, authoring, local, sync, configure, execute, ci, safety, investigate |
supercheck skills install | Write a small skill pointer for an agent (existing files kept unless --force) |
supercheck capabilities --json | Local CLI capabilities; add --online to verify the current server context (does not establish feature availability or permissions) |
supercheck schema config --json | The installed configuration schema |
skills and schema work offline. Local runs need no cloud credentials:
supercheck test run --offline --file ./_supercheck_/playwright/homepage.pw.ts
supercheck job run --id "Nightly E2E" --local --offlineOffline execution runs local files and skips server-side validation. Cloud sync still requires a project-scoped CLI token. See Agent-first operation for JSON, confirmation and resource ownership behavior, or start with the Agent Quickstart.