hookdeck-cli
installs/mo · npmstarsforks
How to install hookdeck-cli?
hookdeck/hookdeck-cli
$git clone https://github.com/hookdeck/hookdeck-cli[![slack-badge]](https://join.slack.com/t/hookdeckdevelopers/shared_invite/zt-yw7hlyzp-EQuO3QvdiBlH9Tz2KZg5MQ)
README.md
| 1 | # Hookdeck CLI |
| 2 | |
| 3 | [slack-badge]: https://img.shields.io/badge/Slack-Hookdeck%20Developers-blue?logo=slack |
| 4 | |
| 5 | [![slack-badge]](https://join.slack.com/t/hookdeckdevelopers/shared_invite/zt-yw7hlyzp-EQuO3QvdiBlH9Tz2KZg5MQ) |
| 6 | |
| 7 | Using the Hookdeck CLI, you can forward your events (e.g. webhooks) to your local web server with unlimited **free** and **permanent** event URLs. Your event history is preserved between sessions and can be viewed, replayed, or used for testing by you and your teammates. |
| 8 | |
| 9 | Hookdeck CLI is compatible with most of Hookdeck's features, such as filtering and fan-out delivery. You can use Hookdeck CLI to develop or test your event (e.g. webhook) integration code locally. |
| 10 | |
| 11 | You can also manage Hookdeck Event Gateway resources—sources, destinations, connections, events, transformations—from the CLI. For AI and agent workflows, the Event Gateway MCP server (`hookdeck gateway mcp`) exposes these capabilities as tools in MCP-compatible clients (e.g. Cursor, Claude). |
| 12 | |
| 13 | Although it uses a different approach and philosophy, it's a replacement for ngrok and alternative HTTP tunnel solutions. |
| 14 | |
| 15 | Hookdeck for development is completely free, and we monetize the platform with our production offering. |
| 16 | |
| 17 | For a complete reference of all commands and flags, see [REFERENCE.md](REFERENCE.md). |
| 18 | |
| 19 | ## Table of contents |
| 20 | |
| 21 | - [Installation](#installation) |
| 22 | - [NPM](#npm) |
| 23 | - [macOS](#macos) |
| 24 | - [Windows](#windows) |
| 25 | - [Linux Or without package managers](#linux-or-without-package-managers) |
| 26 | - [Docker](#docker) |
| 27 | - [Usage](#usage) |
| 28 | - [Commands](#commands) |
| 29 | - [Login](#login) |
| 30 | - [Listen](#listen) |
| 31 | - [Logout](#logout) |
| 32 | - [Skip SSL validation](#skip-ssl-validation) |
| 33 | - [Disable health checks](#disable-health-checks) |
| 34 | - [Version](#version) |
| 35 | - [Completion](#completion) |
| 36 | - [Running in CI](#running-in-ci) |
| 37 | - [Event Gateway](#event-gateway) |
| 38 | - [Event Gateway MCP](#event-gateway-mcp) |
| 39 | - [Manage connections](#manage-connections) |
| 40 | - [Transformations](#transformations) |
| 41 | - [Requests, events, and attempts](#requests-events-and-attempts) |
| 42 | - [Manage active project](#manage-active-project) |
| 43 | - [Telemetry](#telemetry) |
| 44 | - [Configuration files](#configuration-files) |
| 45 | - [Global Flags](#global-flags) |
| 46 | - [Troubleshooting](#troubleshooting) |
| 47 | - [Developing](#developing) |
| 48 | - [Testing](#testing) |
| 49 | - [Releasing](#releasing) |
| 50 | - [Repository Setup](#repository-setup) |
| 51 | - [License](#license) |
| 52 | |
| 53 | **Quick links:** [Local development (Listen)](#listen) · [Resource management (CLI)](#event-gateway) / [Manage connections](#manage-connections) · [AI / agent integration (Event Gateway MCP)](#event-gateway-mcp) |
| 54 | |
| 55 | https://github.com/user-attachments/assets/7a333c5b-e4cb-45bb-8570-29fafd137bd2 |
| 56 | |
| 57 | |
| 58 | ## Installation |
| 59 | |
| 60 | Hookdeck CLI is available for macOS, Windows, and Linux for distros like Ubuntu, Debian, RedHat, and CentOS. |
| 61 | |
| 62 | ### NPM |
| 63 | |
| 64 | Hookdeck CLI is distributed as an NPM package: |
| 65 | |
| 66 | ```sh |
| 67 | npm install hookdeck-cli -g |
| 68 | ``` |
| 69 | |
| 70 | To install a beta (pre-release) version: |
| 71 | |
| 72 | ```sh |
| 73 | npm install hookdeck-cli@beta -g |
| 74 | ``` |
| 75 | |
| 76 | ### macOS |
| 77 | |
| 78 | Hookdeck CLI is available on macOS via [Homebrew](https://brew.sh/) in [homebrew-core](https://github.com/Homebrew/homebrew-core/blob/HEAD/Formula/h/hookdeck.rb): |
| 79 | |
| 80 | ```sh |
| 81 | brew install hookdeck |
| 82 | ``` |
| 83 | |
| 84 | New stable versions are picked up automatically by Homebrew's autobump after each release — `brew upgrade` will pull them in. |
| 85 | |
| 86 | To install a beta (pre-release) version from our tap: |
| 87 | |
| 88 | ```sh |
| 89 | brew install hookdeck/hookdeck/hookdeck-beta |
| 90 | ``` |
| 91 | |
| 92 | > [!NOTE] |
| 93 | > When [`HOMEBREW_REQUIRE_TAP_TRUST`](https://docs.brew.sh/Taps) becomes the default in Homebrew 5.2.0 / 6.0.0, installing the beta formula from a third-party tap will require an explicit trust step: |
| 94 | > ```sh |
| 95 | > brew trust --formula hookdeck/hookdeck/hookdeck-beta |
| 96 | > ``` |
| 97 | > The stable `hookdeck` formula lives in homebrew-core and is not affected. |
| 98 | |
| 99 | ### Windows |
| 100 | |
| 101 | Hookdeck CLI is available on Windows via the [Scoop](https://scoop.sh/) package manager: |
| 102 | |
| 103 | ```sh |
| 104 | scoop bucket add hookdeck https://github.com/hookdeck/scoop-hookdeck-cli.git |
| 105 | scoop install hookdeck |
| 106 | ``` |
| 107 | |
| 108 | To in |
People who liked this also viewed
6 picksType
- fastmcp🚀 The fast, Pythonic way to build MCP servers and clients.MCP ServersJul 2026
- playwright-mcpPlaywright MCP serverMCP ServersJul 2026
- ext-appsOfficial repo for spec & SDK of MCP Apps protocol - standard for UIs embedded AI chatbots, served by MCP serversMCP ServersJul 2026
- langchain-mcp-adaptersLangChain 🔌 MCPMCP ServersJul 2026
- mcporterCall MCPs via TypeScript, masquerading as simple TypeScript API. Or package them as cli.MCP ServersJul 2026
- mcp-proxyA bridge between Streamable HTTP and stdio MCP transportsMCP ServersJul 2026
