Skip to main content

CLI

Kamustatus provides a Go-based CLI tool (kamustatus) for managing monitors, incidents, and more from the terminal.

Installation

Download the latest binary from the releases page or install with Go:

go install github.com/kamustatus/cli/cmd/kamustatus@latest

Configuration

Set your API key as an environment variable or pass it with the --api-key flag:

export KAMUPTIME_API_KEY="km_your_api_key"

Optionally set the base URL (defaults to https://app.kamustatus.com):

export KAMUPTIME_BASE_URL="https://app.kamustatus.com"

Commands

Projects

kamustatus projects list
kamustatus projects get <project-id>
kamustatus projects create --name "Production"
kamustatus projects update <project-id> --name "Production EU"
kamustatus projects delete <project-id>

Monitors

kamustatus monitors list
kamustatus monitors get <monitor-id>
kamustatus monitors create --type http --name "My API" --url "https://api.example.com/health"
kamustatus monitors update <monitor-id> --interval 30
kamustatus monitors delete <monitor-id>
kamustatus monitors stats <monitor-id>
kamustatus monitors daily-uptime <monitor-id> --from 2025-05-01 --to 2025-05-31
kamustatus monitors response-times <monitor-id> --from 2025-05-01 --to 2025-05-31

Alerts

kamustatus channels list
kamustatus channels create --type slack --name "Eng Slack" --config '{"webhookUrl":"https://hooks.slack.com/..."}'
kamustatus channels delete <channel-id>

kamustatus rules list
kamustatus rules create --name "Downtime alert" --monitor <monitor-id> --channel <channel-id> --trigger monitor_down
kamustatus rules delete <rule-id>

kamustatus alert-history --from 2025-05-01 --to 2025-05-31

Incidents

kamustatus incidents list
kamustatus incidents get <incident-id>
kamustatus incidents create --title "API outage" --status investigating --monitor <monitor-id>
kamustatus incidents update <incident-id> --status resolved --message "Issue resolved."
kamustatus incidents delete <incident-id>

Status Pages

kamustatus status-pages list
kamustatus status-pages get <status-page-id>
kamustatus status-pages create --name "Acme Status" --slug acme --monitors mon_abc,mon_def
kamustatus status-pages update <status-page-id> --custom-domain status.example.com
kamustatus status-pages delete <status-page-id>

Billing

kamustatus plans list
kamustatus subscription

Output Formats

Use --output or -o to control output format:

kamustatus monitors list -o json
kamustatus monitors list -o table

Supported formats: table (default), json.

Global Flags

FlagDescription
--api-keyAPI key (overrides KAMUPTIME_API_KEY)
--base-urlBase URL (overrides KAMUPTIME_BASE_URL)
--output, -oOutput format: table or json
--help, -hShow help