From 0db5a39d7be2a8455d343eb9a21c31caa405bfd6 Mon Sep 17 00:00:00 2001 From: Phil Leggetter Date: Mon, 29 Sep 2025 12:50:42 +0100 Subject: [PATCH] docs: clarify connection-query parameter usage in CLI --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9061ba6..64ee197 100644 --- a/README.md +++ b/README.md @@ -167,7 +167,7 @@ twilio -> cli-twilio forwarding to /webhooks/twilio #### Listen to a subset of connections -The 3rd param, `connection-query` can be used to filter the list of connections the CLI will listen to. The connection query can either be the `connection` `alias` or the `path` +The 3rd param, `connection-query` specifies which connection with a CLI destination to adopt for listening. By default, the first connection with a CLI destination type will be used. If a connection with the specified name doesn't exist, a new connection will be created with the passed value. The connection query is checked against the `connection` name, `alias`, and the `path` values. ```sh $ hookdeck listen 3000 shopify orders