Manage status pages, monitors, and incidents from the terminal.
brew install openstatusHQ/cli/openstatus --caskcurl -fsSL https://raw.githubusercontent.com/openstatusHQ/cli/refs/heads/main/install.sh | bashiwr https://raw.githubusercontent.com/openstatusHQ/cli/refs/heads/main/install.ps1 | iex# Run a one-shot HTTP check against a URL from 28 global regions (no auth)
openstatus check https://openstat.us
# Authenticate with your API token
openstatus login
# List your monitors
openstatus monitors list
# Get detailed info on a monitor (live status + latency percentiles)
openstatus monitors info 123
# Trigger an on-demand check
openstatus monitors trigger 123
# Report an incident
openstatus status-report create --title "API degradation" --status investigating --page-id 1
# Report an incident with per-component impact
openstatus sr create --title "API down" --status investigating --message "Investigating" \
--page-id 1 --impact comp_api=major_outage --impact comp_db=degraded
# Update an incident and change impact
openstatus sr add-update sr_42 --status monitoring --message "Recovering" \
--impact comp_api=degraded,comp_db=operational
# Run synthetic tests from config
openstatus runopenstatus check <URL> runs a one-shot HTTP check from 28 global probe
regions via the public OpenStatus speed checker. No API token required.
openstatus check https://openstat.us
openstatus check https://openstat.us -X POST -H 'Authorization: Bearer …' -d '{"ping":true}'
openstatus check https://openstat.us -d @payload.json
openstatus check https://openstat.us --timing # adds DNS/Connection/TLS/TTFB/Transfer columns
openstatus check https://openstat.us --json | jq '.summary'Rate limit: 3 requests per 60 seconds.
| Command | Alias | Description |
|---|---|---|
check | c | Run an HTTP check against a URL from 28 global regions (no auth) |
login / logout | Authenticate with the OpenStatus API | |
whoami | w | Show current workspace info |
monitors | m | List, inspect, trigger, import, and apply monitors |
status-report | sr | Create and manage incident reports |
maintenance | mt | Schedule and manage maintenance windows |
status-page | sp | View status pages and components |
notification | n | View notification channels |
run | r | Run synthetic tests across global regions |
terraform generate | tf gen | Export workspace resources to Terraform HCL |
| Flag | Description |
|---|---|
--json | Machine-readable JSON output |
--quiet, -q | Suppress non-error output |
--debug | Print HTTP request details to stderr |
--no-color | Disable colored output |
--access-token, -t | Override API token |
Define monitors declaratively in YAML and sync them with apply:
# Export existing monitors to openstatus.yaml + openstatus.lock
openstatus monitors import
# Preview changes
openstatus monitors apply --dry-run
# Apply changes
openstatus monitors applyGenerate Terraform HCL for your entire workspace:
openstatus terraform generate --output-dir ./terraformThis creates provider.tf, monitors.tf, notifications.tf, status_pages.tf, private_locations.tf, and imports.tf ready for terraform plan.
The CLI resolves your API token in this order:
--access-token/-tflagOPENSTATUS_API_TOKENenvironment variable- Saved token at
~/.config/openstatus/token(written byopenstatus login)
go test -race ./...go run cmd/docs/docs.go
cd docs
pandoc -s -t man openstatus-docs.md -o openstatus.1