CLI Overview
Manage hookstream from the terminal — stream events live, create sources, replay webhooks, and script everything.
The hookstream CLI (/cli) is a command-line tool for managing your webhook infrastructure. It does everything the dashboard does — plus things the dashboard cannot, like streaming events to your terminal in real time and piping results through jq.
What you can do
When to reach for the CLI
- Local webhook development — run
hookstream listen --forward http://localhost:3000/webhookto receive live webhooks on your laptop. - CI/CD pipelines — create sources, destinations, and connections as part of your deploy scripts.
- Quick ops — triage a failed delivery, reset a circuit breaker, or check metrics without opening the dashboard.
- Bulk operations — replay events, retry failed deliveries, or export collections.
- Debugging —
hookstream events get <id>shows full headers and payload inline.
Command groups
The CLI has 19 command groups and 50+ subcommands. The most common ones:
| Group | Purpose |
|---|---|
login, logout, whoami | Authentication |
init | First-run onboarding wizard |
test, listen | Send test events and stream webhooks live |
sources, destinations, connections | Core pipeline resources |
events, deliveries | Inspect event history and delivery attempts |
metrics | Usage and latency stats |
topics, replay | Pub/sub fan-out and historical replay |
issues, alerts, channels | Observability and notifications |
collections | Instant Database |
applications | Outbound webhooks |
billing | Plan and usage |
See the full command reference for every command and option.
Quick example
Send a test event to a source and watch it arrive in real time — two terminals:
hookstream listenhookstream test src_abc123 --payload '{"type":"test.ping"}'The CLI reads your API key from ~/.config/hookstream/config.json after hookstream login. You can also pass --api-key per command or set HOOKSTREAM_API_KEY — see Authentication.