CLI

The beeps CLI lets you manage relays, schedules, alerts, and integrations directly from the command line — or define your entire on-call setup as code.

Installation

npm (global)

npm install -g @beepsdev/cli

npx

npx @beepsdev/cli --help

Configuration

The CLI needs one environment variable:

Variable	Required	Description
BEEPS_API_KEY	Yes	Your API key from organization settings (looks like bk_xxxxxxxx)

export BEEPS_API_KEY="bk_your_api_key_here"

Quick Commands

See who’s on call

beeps schedule on-call --schedule-id sch_abc123

List active alerts

beeps alert list --active

Resolve an alert

beeps alert resolve --alert-id alt_abc123

List relays

beeps relay list

Simulate a relay

beeps relay simulate --relay-id rly_abc123 --simulate-at 2025-03-01T00:00:00Z

Define your setup as code

beeps relay export -o beeps.config.ts   # export current setup
beeps relay plan -f beeps.config.ts     # preview changes
beeps relay apply -f beeps.config.ts    # apply changes

Reference

• Config-as-Code — define relays, schedules, and rules in TypeScript
• Relay Commands — manage relays and rules directly

All commands support --json for machine-readable output and --help for usage info.