You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 18, 2026. It is now read-only.
docs: CLI README — add local try-it, JSON output example, command descriptions
- "Try it Locally (2 minutes)" section with copy-paste steps
- "Why hookflare?" one-liner differentiator vs SaaS alternatives
- --json output example for connect command (agent-friendly)
- Command table with one-line descriptions per command
- Note on init idempotency and forwarded headers
Copy file name to clipboardExpand all lines: packages/cli/README.md
+73-28Lines changed: 73 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,30 +16,53 @@ Stripe/GitHub/Slack → hookflare (Cloudflare edge) → your API
16
16
└─ never lose an event
17
17
```
18
18
19
-
hookflare sits between webhook providers and your application. It accepts webhooks at 300+ Cloudflare edge locations, verifies signatures, and reliably delivers them to your API with automatic retries, circuit breaking, and a dead letter queue. Zero servers to manage.
19
+
hookflare sits between webhook providers and your application. It accepts webhooks at 300+ Cloudflare edge locations, verifies signatures, and reliably delivers them to your API with automatic retries, circuit breaking, and a dead letter queue. Zero servers to manage, zero idle cost.
20
20
21
-
## Quick Start
21
+
**Why hookflare?** Unlike SaaS webhook tools (Hookdeck, Svix), hookflare runs on **your own** Cloudflare account — you own the data, pay Cloudflare directly ($0 on free tier for most workloads), and deploy in 30 seconds.
22
22
23
-
### 1. Deploy hookflare
24
-
25
-
If you haven't deployed hookflare yet, see the [deployment guide on GitHub](https://github.com/hookedge/hookflare#quick-start) — one-click deploy to Cloudflare or `npx wrangler deploy`.
See the [deployment guide on GitHub](https://github.com/hookedge/hookflare#quick-start) — one-click deploy to Cloudflare or `npx wrangler deploy`.
54
+
55
+
### 2. Install the CLI and bootstrap
34
56
35
57
```bash
58
+
npm i -g hookflare
36
59
hookflare config set api_url https://your-hookflare.workers.dev
37
60
hookflare init # creates your admin API key (stored automatically)
38
61
```
39
62
40
-
`init` calls the one-time bootstrap endpoint to create your first API key. The key is saved to `~/.hookflare/config.json`. All subsequent commands authenticate with it.
63
+
`init` calls the one-time bootstrap endpoint to create your first API key. The key is saved to `~/.hookflare/config.json`. All subsequent commands authenticate with it. Running `init` again on an already-bootstrapped instance is a no-op.
Next: Add this URL to your Stripe Dashboard → Developers → Webhooks.
61
84
```
62
85
63
-
Omit `--events` to forward all events.
86
+
Omit `--events` to forward all events. hookflare forwards the original payload as-is to your destination with these headers added: `X-Hookflare-Event-Id`, `X-Hookflare-Delivery-Id`, `X-Hookflare-Attempt`.
64
87
65
88
## What You Can Do
66
89
67
90
-**Connect providers** — Stripe, GitHub, Slack, Shopify, Vercel with one command
The CLI is built for AI agents. `--json` structured output, `--dry-run` safe validation, `--data` raw JSON input, and `hookflare schema` for runtime API discovery. See [AGENTS.md](https://github.com/hookedge/hookflare/blob/main/packages/cli/AGENTS.md) for the complete agent guide.
98
+
The CLI is built for AI agents. See [AGENTS.md](https://github.com/hookedge/hookflare/blob/main/packages/cli/AGENTS.md) for the complete guide.
0 commit comments