CLI Schedule Commands

These commands let you manage on-call schedules, roster membership, and temporary overrides.

Schedule Commands

List schedules

beeps schedule list
beeps schedule list --json

Create a schedule

beeps schedule create --name "Weekly On-Call" \
  --relay-id rly_abc123 \
  --type weekly \
  --handoff-day monday \
  --handoff-time 09:00

beeps schedule create --name "Daily Rotation" \
  --relay-id rly_abc123 \
  --type daily \
  --handoff-day monday \
  --handoff-time 09:00 \
  --external-key prod-oncall

Flag	Required	Description
--name	Yes	Schedule name
--relay-id	Yes	Relay this schedule belongs to
--type	Yes	daily or weekly
--handoff-day	Yes	Day of week for handoffs (monday-sunday)
--handoff-time	Yes	Time of day for handoffs (HH:MM format)
--start-at	No	Start time as ISO string (omit to start immediately)
--external-key	No	External key for idempotent upserts

Check who’s on call

beeps schedule on-call --schedule-id sch_abc123
beeps schedule on-call --schedule-id sch_abc123 --json

View upcoming assignments

beeps schedule assignments --schedule-id sch_abc123
beeps schedule assignments --schedule-id sch_abc123 --count 5
beeps schedule assignments --schedule-id sch_abc123 --type until --date 2025-03-01T00:00:00Z
beeps schedule assignments --schedule-id sch_abc123 --type days --count 14

Flag	Required	Description
--schedule-id	Yes	Schedule ID
--count	No	Number of assignments to return
--date	No	Show assignments until this date (ISO string)
--type	No	Query type: assignments, until, or days

Member Commands

Add a member

Add by email or user ID:

beeps schedule add-member --schedule-id sch_abc123 --email alice@example.com
beeps schedule add-member --schedule-id sch_abc123 --user-id usr_def456

Remove a member

beeps schedule remove-member --schedule-id sch_abc123 --user-id usr_def456

Override Commands

Overrides let you temporarily replace the on-call person — useful for PTO, shift swaps, or emergency coverage.

Create an override

beeps schedule override create \
  --schedule-id sch_abc123 \
  --user-id usr_def456 \
  --start-at 2025-03-01T00:00:00Z \
  --end-at 2025-03-02T00:00:00Z

beeps schedule override create \
  --schedule-id sch_abc123 \
  --user-id usr_def456 \
  --start-at 2025-03-01T00:00:00Z \
  --end-at 2025-03-02T00:00:00Z \
  --reason "covering for Alice"

Flag	Required	Description
--schedule-id	Yes	Schedule ID
--user-id	Yes	User who will cover the override
--start-at	Yes	Override start time (ISO string)
--end-at	Yes	Override end time (ISO string)
--reason	No	Description of why the override exists

List overrides

beeps schedule override list --schedule-id sch_abc123
beeps schedule override list --schedule-id sch_abc123 \
  --start-at 2025-03-01T00:00:00Z \
  --end-at 2025-04-01T00:00:00Z

Update an override

beeps schedule override update \
  --schedule-id sch_abc123 \
  --override-id ovr_abc123 \
  --end-at 2025-03-03T00:00:00Z

beeps schedule override update \
  --schedule-id sch_abc123 \
  --override-id ovr_abc123 \
  --reason "extended coverage"

Cancel an override

beeps schedule override cancel --schedule-id sch_abc123 --override-id ovr_abc123

Exit Codes

• 0 success
• 1 validation failure or API error