beeps-terminal
v0.1.1
Published
A terminal dashboard for managing on-call incidents via the [beeps.dev](https://beeps.dev) API. Built with [OpenTUI](https://github.com/anomalyco/opentui) and the `@beepsdev/sdk`.
Readme
beeps-terminal
A terminal dashboard for managing on-call incidents via the beeps.dev API. Built with OpenTUI and the @beepsdev/sdk.
Prerequisites
- Bun v1.0+
- A beeps.dev API key
Install
cd beeps-terminal
bun installUsage
BEEPS_API_KEY=your-api-key bun startOr with a .env file (Bun loads these automatically):
# .env
BEEPS_API_KEY=bp_live_xxxxxxxxxxxxbun startEnvironment Variables
| Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| BEEPS_API_KEY | Yes | | Your beeps.dev API key |
| BEEPS_BASE_URL | No | https://api.beeps.dev/v0 | API base URL |
| BEEPS_REFRESH_INTERVAL | No | 20000 | Auto-refresh interval in milliseconds |
Keyboard Shortcuts
| Key | Action |
|-----|--------|
| q / Ctrl+C | Quit |
| Up / Down | Navigate alerts |
| Enter | Toggle alert detail view |
| Escape | Collapse detail view |
| a | Acknowledge selected alert |
| r | Resolve selected alert |
| e | Escalate selected alert |
Layout
The dashboard has two panes in a 60/40 split:
┌───────────────────────────────────┬────────────────────────┐
│ │ │
│ Active Alerts │ On-Call Roster │
│ (scrollable list) │ (or Alert Detail when │
│ │ expanded with Enter) │
│ │ │
│ │ │
│ │ │
└───────────────────────────────────┴────────────────────────┘- Left pane -- Active alerts from your beeps.dev account. Shows severity, source, assignment, and acknowledgement status. The selected alert is highlighted.
- Right pane -- On-call roster pulled from your schedules, showing who is on call, their schedule, and when their shift ends. Press
Enteron an alert to swap this pane to a detailed alert view.
