Skip to content

CLI Relay Commands

These commands focus on relay behavior and readiness checks.

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

Terminal window
beeps relay lint --relay-id rly_123 --coverage-days 7

JSON output for CI:

Terminal window
beeps relay lint --relay-id rly_123 --coverage-days 7 --json

Preview who would be notified at a specific time.

Terminal window
beeps relay simulate --relay-id rly_123 --simulate-at 2025-01-01T00:00:00Z

With a payload:

Terminal window
beeps relay simulate --relay-id rly_123 --simulate-at 2025-01-01T00:00:00Z --payload ./payload.json

Use config-as-code to preview and apply changes:

Terminal window
beeps relay plan -f beeps.config.ts
beeps relay apply -f beeps.config.ts
  • 0 success
  • 1 validation failure or API error