CLI Overview

The Supercheck CLI (@supercheck/cli) provides a first-class command-line interface for CI/CD pipelines, automation workflows, and monitoring-as-code. Built with TypeScript, it supports all major Supercheck operations — jobs, tests, monitors, variables, and more.

View the package on npm.

Key Features

• CI/CD Integration — Trigger jobs, wait for results, and gate deployments
• Monitoring-as-Code — Define monitors, tests, jobs, notification providers, variables, tags, and status pages in supercheck.config.ts
• Full CRUD — Manage all resources from the terminal
• JSON Output — Machine-readable output for scripting with --json
• Retry & Rate Limiting — Automatic retries with exponential backoff
• Self-Hosted Support — Works with any Supercheck deployment

Quick Start

# Install globally
npm install -g @supercheck/cli

# Authenticate with your CLI token
supercheck login --token sck_live_...

# Verify connection
supercheck whoami
supercheck health

# List resources
supercheck job list
supercheck monitor list
supercheck test list

How It Works

Most CLI commands use CLI tokens (sck_live_*). supercheck job trigger is the exception: it uses a job-specific trigger key (sck_trigger_*) and optionally a CLI token when waiting for completion.

supercheck.config.ts          → Defines resources (monitoring-as-code)
SUPERCHECK_TOKEN env var      → Authenticates API requests
SUPERCHECK_TRIGGER_KEY env var → Authenticates job trigger requests
supercheck deploy             → Pushes config to Supercheck API
supercheck job trigger <id>   → Triggers jobs from CI/CD

Next Steps

• Installation — Install and set up the CLI
• Authentication — Token types and security
• Configuration — supercheck.config.ts reference
• Commands — Full command reference
• CI/CD Integration — GitHub Actions, GitLab CI, Docker