Command-line tool (CLI)

Install

The pingerer command needs Ruby 3.2 or newer and nothing else.

gem install pingerer

Sign in

Create an API token (API), then:

pingerer login     # asks for the token, checks it and saves it
pingerer whoami

The token is saved in ~/.config/pingerer/config.json, readable only by you. In CI, set PINGERER_TOKEN instead. pingerer logout forgets it.

Accounts

pingerer accounts
pingerer use "Your Bakery"        # from now on
pingerer status --account 42      # just this once

Sites and monitors

pingerer status                                   # exits 3 when something is down
pingerer sites
pingerer sites add yourbakery.com --checks http,ssl,domain --every 1m
pingerer sites show yourbakery.com
pingerer sites pause yourbakery.com
pingerer sites rm yourbakery.com --yes

pingerer monitors --site yourbakery.com
pingerer monitors test mon_8xKq2                  # one check now; exits 3 if it fails
pingerer results mon_8xKq2 --since 24h --failed

Incidents

pingerer incidents --open
pingerer incidents show INC-0042
pingerer incidents ack INC-0042
pingerer incidents note INC-0042 Restarted the web server
pingerer incidents resolve INC-0042 -m "Fixed by the host"

Heartbeats

pingerer heartbeats add "Nightly backup" --every 1d --grace 30m
pingerer heartbeats ping "Nightly backup"
pingerer heartbeats ping YOUR-TOKEN --fail        # by token, no login needed

Status pages and maintenance

pingerer status-pages list
pingerer status-pages show your-bakery
pingerer updates post your-bakery --state investigating --title "Checkout errors" \
  --message "We're looking into it." --component "Online shop=partial_outage"
pingerer updates post your-bakery --state resolved --message "Fixed." --follow-up su_8Fk2
pingerer maintenance list

In CI and scripts

export PINGERER_TOKEN=...   # a read-only token is enough
pingerer status || echo "Something is down"

Every command takes --json, --account and --[no-]color (color is off when NO_COLOR is set). Exit codes: 0 ok, 1 an error, 2 wrong usage, 3 something is down. pingerer help and pingerer <command> --help list the rest.