Guides / CLI

CLI

The thump command-line client: check status, force-run probes, and list incidents from the terminal — with JSON output and CI-friendly exit codes.

On this page

CLI

thump is a zero-dependency command-line client for the thump API. Check status, force-run probes, and list incidents without leaving the terminal — plus the private-network agent for endpoints our cloud probes can't reach.

Install

From the repo (npm publish is coming):

pnpm --filter @thump/cli build
node apps/cli/dist/main.js help

Link it as thump on your PATH:

cd apps/cli && npm link

Requires Node 20+. No runtime dependencies.

Authenticate

Create a personal access token in the dashboard under Settings → API tokens, then:

thump login --token thump_pat_…

The token is validated against the API and saved to ~/.config/thump/config.json (mode 0600). Alternatives that skip the saved config:

Self-hosted instances: add --api-url https://your-instance.dev to login (persisted) or any command (one-off).

Commands

thump status                 account overview: totals + recent incidents
thump monitors               list monitors
thump run <id>               force-run a monitor in every region
thump incidents <id>         list a monitor's incidents (--status open|resolved|all)
thump whoami                 show the authenticated user
thump agent                  private-network agent (see the guide)

Monitor ids accept an unambiguous prefix — thump run 0f8b7c62 works as long as only one monitor starts with it.

JSON output

Every read command takes --json for machine-readable output:

thump monitors --json | jq '.[] | select(.enabled) | .url'

Exit codes

CodeMeaning
0success
1error (bad flags, auth failure, API error)
2thump run: at least one region reported down · thump agent --once: at least one check failed

thump run + exit code 2 makes a serviceable deploy gate in any CI system — or use the ready-made GitHub Action.