|
| 1 | +# hookflare |
| 2 | + |
| 3 | +**Never miss a webhook.** CLI for [hookflare](https://github.com/hookedge/hookflare) — open-source webhook infrastructure on Cloudflare Workers. |
| 4 | + |
| 5 | +```bash |
| 6 | +npm i -g hookflare |
| 7 | +``` |
| 8 | + |
| 9 | +## Quick Start |
| 10 | + |
| 11 | +```bash |
| 12 | +# Connect to your hookflare instance |
| 13 | +hookflare config set api_url https://your-hookflare.workers.dev |
| 14 | +hookflare init |
| 15 | + |
| 16 | +# Set up Stripe webhooks in one command |
| 17 | +hookflare connect stripe \ |
| 18 | + --secret whsec_your_secret \ |
| 19 | + --to https://api.myapp.com/hooks \ |
| 20 | + --events "payment_intent.*" |
| 21 | +``` |
| 22 | + |
| 23 | +## Agent-Friendly |
| 24 | + |
| 25 | +hookflare CLI is designed as an **agent-first** interface. AI agents can operate hookflare without reading documentation. |
| 26 | + |
| 27 | +```bash |
| 28 | +# Discover → Validate → Execute |
| 29 | +hookflare schema sources # discover API fields |
| 30 | +hookflare connect stripe --dry-run --json -d '{...}' # validate |
| 31 | +hookflare connect stripe --json -d '{...}' # execute |
| 32 | +``` |
| 33 | + |
| 34 | +| Feature | Flag/Command | Purpose | |
| 35 | +|---|---|---| |
| 36 | +| Structured output | `--json` | Machine-parseable JSON on all commands | |
| 37 | +| Raw JSON input | `-d / --data` | Full API payload, skip flag mapping | |
| 38 | +| Schema introspection | `hookflare schema` | Discover resources and fields at runtime | |
| 39 | +| Provider catalog | `hookflare providers` | Browse supported webhook services | |
| 40 | +| Dry run | `--dry-run` | Validate mutations without executing | |
| 41 | +| Field selection | `--fields` | Limit output columns, save context tokens | |
| 42 | + |
| 43 | +## Commands |
| 44 | + |
| 45 | +```bash |
| 46 | +hookflare connect <provider> # One-shot: source + destination + subscription |
| 47 | +hookflare providers ls # List supported webhook providers |
| 48 | +hookflare providers describe # Inspect provider events and verification |
| 49 | +hookflare dev # Local dev tunnel with signature verification |
| 50 | +hookflare tail # Real-time event and delivery streaming |
| 51 | + |
| 52 | +hookflare sources ls/create/rm # Manage webhook sources |
| 53 | +hookflare dest ls/create/rm # Manage destinations |
| 54 | +hookflare subs ls/create/rm # Manage subscriptions |
| 55 | +hookflare events ls/get/replay # View events and deliveries |
| 56 | + |
| 57 | +hookflare export/import # Backup and restore configuration |
| 58 | +hookflare migrate # Instance-to-instance migration |
| 59 | +hookflare health # Check server connectivity |
| 60 | +hookflare schema [resource] # API schema introspection |
| 61 | +hookflare config set/get # CLI configuration |
| 62 | +hookflare init # Bootstrap a fresh instance |
| 63 | +``` |
| 64 | + |
| 65 | +## Configuration |
| 66 | + |
| 67 | +```bash |
| 68 | +hookflare config set api_url https://your-hookflare.workers.dev |
| 69 | +hookflare config set token hf_sk_your_api_key |
| 70 | +``` |
| 71 | + |
| 72 | +Config is stored in `~/.hookflare/config.json`. |
| 73 | + |
| 74 | +## For AI Agents |
| 75 | + |
| 76 | +See [AGENTS.md](https://github.com/hookedge/hookflare/blob/main/packages/cli/AGENTS.md) for the complete agent guide, including: |
| 77 | +- Rules (always use `--json`, `--dry-run`, `--data`) |
| 78 | +- Common workflows (Stripe setup, monitoring, troubleshooting) |
| 79 | +- Resource ID format (`src_`, `dst_`, `sub_`, `evt_`, `dlv_`, `key_`) |
| 80 | +- DLQ notification setup |
| 81 | +- Verification types table |
| 82 | + |
| 83 | +## Links |
| 84 | + |
| 85 | +- [GitHub](https://github.com/hookedge/hookflare) |
| 86 | +- [Agent Guide (AGENTS.md)](https://github.com/hookedge/hookflare/blob/main/packages/cli/AGENTS.md) |
| 87 | +- [Benchmarks](https://github.com/hookedge/hookflare/blob/main/BENCHMARKS.md) |
| 88 | + |
| 89 | +## License |
| 90 | + |
| 91 | +[Apache 2.0](https://github.com/hookedge/hookflare/blob/main/LICENSE) |
0 commit comments