CLI Relay Commands

These commands let you interact with relays and rules directly, without a config file.

Relay Commands

List relays

beeps relay list
beeps relay list --json

Create a relay

beeps relay create --name "Production Alerts" --external-key prod-alerts
beeps relay create --name "Production Alerts" --description "Routes critical incidents" --json
beeps relay create --name "Production Alerts" --repeat all

--repeat controls what happens when every rule has fired and the alert is still unacknowledged: none (default) stops, once runs the plan a second time, all keeps repeating until someone responds. Repeat cycles start no sooner than 5 minutes apart.

Lint a relay

Validate a relay’s rules, schedules, and contact method coverage.

beeps relay lint --relay-id rly_abc123
beeps relay lint --relay-id rly_abc123 --coverage-days 7 --json

Simulate a relay

Preview who would be notified at a specific time.

beeps relay simulate --relay-id rly_abc123 --simulate-at 2025-01-01T00:00:00Z
beeps relay simulate --relay-id rly_abc123 --simulate-at 2025-01-01T00:00:00Z --payload alert.json
cat alert.json | beeps relay simulate --relay-id rly_abc123 --simulate-at 2025-01-01T00:00:00Z --payload -

Relay Rule Commands

List rules

beeps relay rule list --relay-id rly_abc123
beeps relay rule list --relay-id rly_abc123 --enabled
beeps relay rule list --relay-id rly_abc123 --rule-type webhook --json

Get a rule

beeps relay rule get --relay-id rly_abc123 --rule-id rul_def456
beeps relay rule get --relay-id rly_abc123 --rule-id rul_def456 --json

Create a rule

beeps relay rule create --relay-id rly_abc123 \
  --name "Notify On-Call" \
  --rule-type schedule_notify \
  --config '{"scheduleId":"sch_def456"}'

beeps relay rule create --relay-id rly_abc123 \
  --name "Notify Secondary" \
  --rule-type schedule_notify \
  --delay 5 \
  --config '{"scheduleId":"sch_backup"}'

beeps relay rule create --relay-id rly_abc123 \
  --name "Slack Hook" \
  --rule-type webhook \
  --group agents \
  --order 1 \
  --config '{"endpoint":"https://hooks.slack.com/..."}'

--delay <minutes> (0–1440, default 0) holds the rule back after the alert arrives; it is cancelled if the alert is acknowledged or resolved first.

Delete a rule

beeps relay rule delete --relay-id rly_abc123 --rule-id rul_def456

Webhook Commands

List webhooks

beeps webhook list --relay-id rly_abc123
beeps webhook list --relay-id rly_abc123 --json

Config-as-Code Commands

For managing relays declaratively via a config file, see Config-as-Code.

beeps relay plan -f beeps.config.ts
beeps relay apply -f beeps.config.ts
beeps relay apply -f beeps.config.ts --dry-run
beeps relay export -o beeps.config.ts

Exit Codes

• 0 success
• 1 validation failure or API error