hookdeck-cli 1.1.0 → 1.2.0-beta.1

package/README.md

@@ -14,7 +14,8 @@ Hookdeck for development is completely free, and we monetize the platform with o
 
 For a complete reference, see the [CLI reference](https://hookdeck.com/docs/cli?ref=github-hookdeck-cli).
 
-https://github.com/user-attachments/assets/5fca7842-9c41-411c-8cd6-2f32f84fa907
+https://github.com/user-attachments/assets/7a333c5b-e4cb-45bb-8570-29fafd137bd2
+
 
 ## Installation
 
@@ -28,6 +29,12 @@ Hookdeck CLI is distributed as an NPM package:
 npm install hookdeck-cli -g
 ```
 
+To install a beta (pre-release) version:
+
+```sh
+npm install hookdeck-cli@beta -g
+```
+
 ### macOS
 
 Hookdeck CLI is available on macOS via [Homebrew](https://brew.sh/):
@@ -36,6 +43,12 @@ Hookdeck CLI is available on macOS via [Homebrew](https://brew.sh/):
 brew install hookdeck/hookdeck/hookdeck
 ```
 
+To install a beta (pre-release) version:
+
+```sh
+brew install hookdeck/hookdeck/hookdeck-beta
+```
+
 ### Windows
 
 Hookdeck CLI is available on Windows via the [Scoop](https://scoop.sh/) package manager:
@@ -45,6 +58,12 @@ scoop bucket add hookdeck https://github.com/hookdeck/scoop-hookdeck-cli.git
 scoop install hookdeck
 ```
 
+To install a beta (pre-release) version:
+
+```sh
+scoop install hookdeck-beta
+```
+
 ### Linux Or without package managers
 
 To install the Hookdeck CLI on Linux without a package manager:
@@ -53,6 +72,8 @@ To install the Hookdeck CLI on Linux without a package manager:
 2. Unzip the file: tar -xvf hookdeck_X.X.X_linux_amd64.tar.gz
 3. Run the executable: ./hookdeck
 
+For beta (pre-release) versions, download the `.deb` or `.rpm` packages from the [GitHub releases page](https://github.com/hookdeck/hookdeck-cli/releases) (look for releases marked as "Pre-release").
+
 ### Docker
 
 The CLI is also available as a Docker image: [`hookdeck/hookdeck-cli`](https://hub.docker.com/r/hookdeck/hookdeck-cli).
@@ -62,6 +83,14 @@ docker run --rm -it hookdeck/hookdeck-cli version
 hookdeck version x.y.z (beta)
 ```
 
+To use a specific version (including beta releases), specify the version tag:
+
+```sh
+docker run --rm -it hookdeck/hookdeck-cli:v1.2.3-beta.1 version
+```
+
+Note: Beta releases do not update the `latest` tag. Only stable releases update `latest`.
+
 If you want to login to your Hookdeck account with the CLI and persist
 credentials, you can bind mount the `~/.config/hookdeck` directory:
 
@@ -111,7 +140,16 @@ hookdeck login --interactive
 Start a session to forward your events to an HTTP server.
 
 ```sh
-hookdeck listen <port-or-URL> <source-alias?> <connection-query?> [--path?] [--output?]
+hookdeck listen <port-or-URL> <source-alias?> <connection-query?> [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.
@@ -410,6 +448,27 @@ Events • [↑↓] Navigate ─────────────────
 > ✓ Last event succeeded with status 200 | [r] Retry • [o] Open in dashboard • [d] Show data
 ```
 
+### Manage connections
+
+Create and manage webhook connections between sources and destinations with inline resource creation, authentication, processing rules, and lifecycle management. For detailed examples with authentication, filters, retry rules, and rate limiting, see the complete [connection management](#manage-connections) section below.
+
+```sh
+hookdeck connection [command]
+
+# Available commands
+hookdeck connection list      # List all connections
+hookdeck connection get       # Get connection details
+hookdeck connection create    # Create a new connection
+hookdeck connection upsert    # Create or update a connection (idempotent)
+hookdeck connection delete    # Delete a connection
+hookdeck connection enable    # Enable a connection
+hookdeck connection disable   # Disable a connection
+hookdeck connection pause     # Pause a connection
+hookdeck connection unpause   # Unpause a connection
+hookdeck connection archive   # Archive a connection
+hookdeck connection unarchive # Unarchive a connection
+```
+
 ### Manage active project
 
 If you are a part of multiple projects, you can switch between them using our project management commands.
@@ -476,6 +535,264 @@ hookdeck project use [<organization_name> [<project_name>]]
 Upon successful selection, you will generally see a confirmation message like:
 `Successfully set active project to: [<organization_name>] <project_name>`
 
+### Manage connections
+
+Connections link sources to destinations and define how events are processed. You can create connections, including source/destination definitions, configure authentication, add processing rules (retry, filter, transform, delay, deduplicate), and manage their lifecycle.
+
+#### Create a connection
+
+Create a new connection between a source and destination. You can create the source and destination inline or reference existing resources:
+
+```sh
+# Basic connection with inline source and destination
+$ hookdeck connection create \
+  --source-name "github-repo" \
+  --source-type GITHUB \
+  --destination-name "ci-system" \
+  --destination-type HTTP \
+  --destination-url "https://api.example.com/webhooks"
+
+✔ Connection created successfully
+Connection: github-repo-to-ci-system (conn_abc123)
+Source: github-repo (src_xyz789)
+Source URL: https://hkdk.events/src_xyz789
+Destination: ci-system (dst_def456)
+
+# Using existing source and destination
+$ hookdeck connection create \
+  --source "existing-source-name" \
+  --destination "existing-dest-name" \
+  --name "new-connection" \
+  --description "Connects existing resources"
+```
+
+#### Add source authentication
+
+Verify webhooks from providers like Stripe, GitHub, or Shopify by adding source authentication:
+
+```sh
+# Stripe webhook signature verification
+$ hookdeck connection create \
+  --source-name "stripe-prod" \
+  --source-type STRIPE \
+  --source-webhook-secret "whsec_abc123xyz" \
+  --destination-name "payment-api" \
+  --destination-type HTTP \
+  --destination-url "https://api.example.com/webhooks/stripe"
+
+# GitHub webhook signature verification
+$ hookdeck connection create \
+  --source-name "github-webhooks" \
+  --source-type GITHUB \
+  --source-webhook-secret "ghp_secret123" \
+  --destination-name "ci-system" \
+  --destination-type HTTP \
+  --destination-url "https://ci.example.com/webhook"
+```
+
+#### Add destination authentication
+
+Secure your destination endpoint with bearer tokens, API keys, or basic authentication:
+
+```sh
+# Destination with bearer token
+$ hookdeck connection create \
+  --source-name "webhook-source" \
+  --source-type HTTP \
+  --destination-name "secure-api" \
+  --destination-type HTTP \
+  --destination-url "https://api.example.com/webhooks" \
+  --destination-bearer-token "bearer_token_xyz"
+
+# Destination with API key
+$ hookdeck connection create \
+  --source-name "webhook-source" \
+  --source-type HTTP \
+  --destination-name "api-endpoint" \
+  --destination-type HTTP \
+  --destination-url "https://api.example.com/webhooks" \
+  --destination-api-key "your_api_key"
+
+# Destination with custom headers
+$ hookdeck connection create \
+  --source-name "webhook-source" \
+  --source-type HTTP \
+  --destination-name "custom-api" \
+  --destination-type HTTP \
+  --destination-url "https://api.example.com/webhooks"
+```
+
+#### Configure retry rules
+
+Add automatic retry logic with exponential or linear backoff:
+
+```sh
+# Exponential backoff retry strategy
+$ hookdeck connection create \
+  --source-name "payment-webhooks" \
+  --source-type STRIPE \
+  --destination-name "payment-api" \
+  --destination-type HTTP \
+  --destination-url "https://api.example.com/payments" \
+  --rule-retry-strategy exponential \
+  --rule-retry-count 5 \
+  --rule-retry-interval 60000
+```
+
+#### Add event filters
+
+Filter events based on request body, headers, path, or query parameters:
+
+```sh
+# Filter by event type in body
+$ hookdeck connection create \
+  --source-name "events" \
+  --source-type HTTP \
+  --destination-name "processor" \
+  --destination-type HTTP \
+  --destination-url "https://api.example.com/process" \
+  --rule-filter-body '{"event_type":"payment.succeeded"}'
+
+# Combined filtering
+$ hookdeck connection create \
+  --source-name "shopify-webhooks" \
+  --source-type SHOPIFY \
+  --destination-name "order-processor" \
+  --destination-type HTTP \
+  --destination-url "https://api.example.com/orders" \
+  --rule-filter-body '{"type":"order"}' \
+  --rule-retry-strategy exponential \
+  --rule-retry-count 3
+```
+
+#### Configure rate limiting
+
+Control the rate of event delivery to your destination:
+
+```sh
+# Limit to 100 requests per minute
+$ hookdeck connection create \
+  --source-name "high-volume-source" \
+  --source-type HTTP \
+  --destination-name "rate-limited-api" \
+  --destination-type HTTP \
+  --destination-url "https://api.example.com/endpoint" \
+  --destination-rate-limit 100 \
+  --destination-rate-limit-period minute
+```
+
+#### Upsert connections
+
+Create or update connections idempotently based on connection name - perfect for CI/CD and infrastructure-as-code workflows:
+
+```sh
+# Create if doesn't exist, update if it does
+$ hookdeck connection upsert my-connection \
+  --source-name "stripe-prod" \
+  --source-type STRIPE \
+  --destination-name "api-prod" \
+  --destination-type HTTP \
+  --destination-url "https://api.example.com"
+
+# Partial update of existing connection
+$ hookdeck connection upsert my-connection \
+  --description "Updated description" \
+  --rule-retry-count 5
+
+# Preview changes without applying (dry-run)
+$ hookdeck connection upsert my-connection \
+  --description "New description" \
+  --dry-run
+
+-- Dry Run: UPDATE --
+Connection 'my-connection' (conn_123) will be updated with the following changes:
+- Description: "New description"
+```
+
+#### List and filter connections
+
+View all connections with flexible filtering options:
+
+```sh
+# List all connections
+$ hookdeck connection list
+
+# Filter by source or destination
+$ hookdeck connection list --source src_abc123
+$ hookdeck connection list --destination dest_xyz789
+
+# Filter by name pattern
+$ hookdeck connection list --name "production-*"
+
+# Include disabled or paused connections
+$ hookdeck connection list --disabled
+$ hookdeck connection list --paused
+
+# Output as JSON
+$ hookdeck connection list --output json
+```
+
+#### Get connection details
+
+View detailed information about a specific connection:
+
+```sh
+# Get by ID
+$ hookdeck connection get conn_123abc
+
+# Get by name
+$ hookdeck connection get "my-connection"
+
+# Get as JSON
+$ hookdeck connection get conn_123abc --output json
+```
+
+#### Connection lifecycle management
+
+Control connection state and event processing behavior:
+
+```sh
+# Disable a connection (stops receiving events entirely)
+$ hookdeck connection disable conn_123abc
+
+# Enable a disabled connection
+$ hookdeck connection enable conn_123abc
+
+# Pause a connection (queues events without forwarding)
+$ hookdeck connection pause conn_123abc
+
+# Resume a paused connection
+$ hookdeck connection unpause conn_123abc
+
+# Archive a connection (hide from main lists)
+$ hookdeck connection archive conn_123abc
+
+# Restore an archived connection
+$ hookdeck connection unarchive conn_123abc
+```
+
+**State differences:**
+- **Disabled**: Connection stops receiving events entirely
+- **Paused**: Connection queues events but doesn't forward them (useful during maintenance)
+- **Archived**: Connection is hidden from main lists but can be restored
+
+#### Delete a connection
+
+Delete a connection permanently:
+
+```sh
+# Delete with confirmation prompt
+$ hookdeck connection delete conn_123abc
+
+# Delete by name
+$ hookdeck connection delete "my-connection"
+
+# Skip confirmation
+$ hookdeck connection delete conn_123abc --force
+```
+
+For complete flag documentation and all examples, see the [CLI reference](https://hookdeck.com/docs/cli?ref=github-hookdeck-cli).
+
 ## Configuration files
 
 The Hookdeck CLI uses configuration files to store the your keys, project settings, profiles, and other configurations.
@@ -613,6 +930,40 @@ Then run the locally generated `hookdeck-cli` binary:
 ./hookdeck-cli
 ```
 
+## Testing
+
+### Running Acceptance Tests
+
+The Hookdeck CLI includes comprehensive acceptance tests written in Go. These tests verify end-to-end functionality by executing the CLI and validating outputs.
+
+**Local testing:**
+
+```bash
+# Run all acceptance tests
+go test ./test/acceptance/... -v
+
+# Run specific test
+go test ./test/acceptance/... -v -run TestCLIBasics
+
+# Skip acceptance tests (short mode)
+go test ./test/acceptance/... -short
+```
+
+**Environment setup:**
+
+For local testing, create a `.env` file in `test/acceptance/`:
+
+```bash
+# test/acceptance/.env
+HOOKDECK_CLI_TESTING_API_KEY=your_api_key_here
+```
+
+**CI/CD:**
+
+In CI environments, set the `HOOKDECK_CLI_TESTING_API_KEY` environment variable directly in your workflow configuration or repository secrets.
+
+For detailed testing documentation and troubleshooting, see [`test/acceptance/README.md`](test/acceptance/README.md).
+
 ### Testing against a local API
 
 When testing against a non-production Hookdeck API, you can use the
@@ -633,6 +984,90 @@ docker run --rm -it \
     http://host.docker.internal:1234
 ```
 
+## Releasing
+
+This section describes the branching strategy and release process for the Hookdeck CLI.
+
+### Branching Strategy
+
+The project uses two primary branches:
+
+- **`main`** - The stable, production-ready branch. All production releases are created from this branch.
+- **`next`** - The beta/pre-release branch. All new features are merged here first for testing before being promoted to `main`.
+
+### Beta Releases
+
+Beta releases allow you to publish pre-release versions for testing without blocking the `main` branch or affecting stable releases.
+
+**Process:**
+
+1. Ensure all desired features are merged into the `next` branch
+2. Pull the latest changes locally:
+   ```sh
+   git checkout next
+   git pull origin next
+   ```
+3. Create and push a beta tag with a pre-release identifier:
+   ```sh
+   git tag v1.2.3-beta.0
+   git push origin v1.2.3-beta.0
+   ```
+4. The GitHub Actions workflow will automatically:
+   - Build binaries for all platforms (macOS, Linux, Windows)
+   - Create a GitHub pre-release (marked as "Pre-release")
+   - Publish to NPM with the `beta` tag
+   - Create beta packages:
+     - Homebrew: `hookdeck-beta` formula
+     - Scoop: `hookdeck-beta` package
+     - Docker: Tagged with the version (e.g., `v1.2.3-beta.0`), but not `latest`
+
+**Installing beta releases:**
+
+```sh
+# NPM
+npm install hookdeck-cli@beta -g
+
+# Homebrew
+brew install hookdeck/hookdeck/hookdeck-beta
+
+# Scoop
+scoop install hookdeck-beta
+
+# Docker
+docker run hookdeck/hookdeck-cli:v1.2.3-beta.0 version
+```
+
+### Production Releases
+
+Production releases are created from the `main` branch using GitHub's release interface.
+
+**Process:**
+
+1. Merge the `next` branch into `main`:
+   ```sh
+   git checkout main
+   git pull origin main
+   git merge next
+   git push origin main
+   ```
+2. Go to the [GitHub Releases page](https://github.com/hookdeck/hookdeck-cli/releases)
+3. Click "Draft a new release"
+4. Create a new tag with a stable version (e.g., `v1.3.0`)
+5. Target the `main` branch
+6. Generate release notes or write them manually
+7. Publish the release
+
+The GitHub Actions workflow will automatically:
+- Build binaries for all platforms
+- Create a stable GitHub release
+- Publish to NPM with the `latest` tag
+- Update package managers:
+  - Homebrew: `hookdeck` formula
+  - Scoop: `hookdeck` package
+  - Docker: Updates both the version tag and `latest`
+
+**Note:** Only stable releases (without pre-release identifiers) will update the `latest` tags across all distribution channels.
+
 ## License
 
 Copyright (c) Hookdeck. All rights reserved.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hookdeck-cli",
-  "version": "1.1.0",
+  "version": "1.2.0-beta.1",
   "description": "Hookdeck CLI",
   "repository": {
     "type": "git",