From 244778d8444e39aa3e7b2fd1bfd7b28a1c1c7b6b Mon Sep 17 00:00:00 2001 From: Phil Leggetter Date: Mon, 27 Oct 2025 10:45:07 +0000 Subject: [PATCH] chore(docs): update listen command flags and descriptions in README --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e0832b2..d82e0ff 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,16 @@ hookdeck login --interactive Start a session to forward your events to an HTTP server. ```sh -hookdeck listen [--path?] [--output?] +hookdeck listen [flags] + +Flags: + --path string Sets the path to which events are forwarded (e.g., /webhooks or /api/stripe) + --output string Output mode: interactive (full UI), compact (simple logs), quiet (only fatal errors) (default "interactive") + --max-connections int Maximum concurrent connections to local endpoint (default: 50, increase for high-volume testing) + --filter-body string Filter events by request body using Hookdeck filter syntax (JSON) + --filter-headers string Filter events by request headers using Hookdeck filter syntax (JSON) + --filter-query string Filter events by query parameters using Hookdeck filter syntax (JSON) + --filter-path string Filter events by request path using Hookdeck filter syntax (JSON) ``` Hookdeck works by routing events received for a given `source` (i.e., Shopify, Github, etc.) to its defined `destination` by connecting them with a `connection` to a `destination`. The CLI allows you to receive events for any given connection and forward them to your localhost at the specified port or any valid URL.