Skip to content

WardenPoint/wardenpoint-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wardenpoint CLI

CI Go Reference License: MIT

Fire and manage WardenPoint incident alerts from scripts, cron jobs and CI pipelines — a single static binary, no dependencies.

WardenPoint is incident-alerting and on-call escalation software: it pages the on-call responder across Telegram, phone, SMS, email, Slack and more, and escalates until someone acknowledges. This CLI is the quickest way to send an alert from a shell.

Install

go install github.com/WardenPoint/wardenpoint-cli@latest   # installs the `wardenpoint-cli` binary

Or grab a prebuilt binary from the releases page and put it on your PATH as wardenpoint.

Authenticate

Create an API key in the dashboard (Integrations → API keys), then either:

wardenpoint auth login --api-key wp_live_xxx     # saved to ~/.config/wardenpoint/config.json (0600)

or set an environment variable (handy in CI):

export WARDENPOINT_API_KEY=wp_live_xxx

Self-hosted / staging? Point at another API root with --base-url or WARDENPOINT_BASE_URL (default https://wardenpoint.com/api/v1).

Usage

# send to a recipient (UUID or exact name) at a priority
wardenpoint alert send --to ops-oncall -m "DB primary down" -p high

# send to a whole group
wardenpoint alert send --group <group-uuid> -p critical -m "API latency SLO burn"

# alert on failure from any script / cron / CI
./nightly-backup.sh || wardenpoint alert send --to <uuid> -p critical \
  -m "nightly backup failed on $(hostname)"

# pipe the message in
tail -n1 error.log | wardenpoint alert send --to <uuid> -p high

# fire a pre-configured template with variables
wardenpoint template fire disk-full --var host=web-3 --var pct=95 -p high

# inspect & acknowledge
wardenpoint alert list
wardenpoint alert status <id>
wardenpoint alert ack <uuid>

# helpers
wardenpoint recipients list
wardenpoint health         # connectivity check (no auth)
wardenpoint --json alert list   # raw JSON for scripting

Priorities: low, normal, high, critical.

Every command exits non-zero on failure, so it composes cleanly in pipelines.

Configuration precedence

--api-key / --base-url flags → WARDENPOINT_API_KEY / WARDENPOINT_BASE_URL → config file → defaults.

Development

go build ./...
go test ./...
go vet ./...

License

MIT — see LICENSE.

About

WardenPoint CLI — fire and manage incident alerts from scripts, cron and CI. Single static Go binary.

Topics

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages