CLI Installation
Install the HookWatch CLI to forward webhooks to your local development server, manage cron jobs, and use the interactive dashboard.
Download
Download the latest release for your platform from the GitHub Releases page.
macOS (Apple Silicon)
For Intel Macs, use hookwatch_darwin_amd64.tar.gz
Linux (x86_64)
For ARM64, use hookwatch_linux_arm64.tar.gz
Windows
Download hookwatch_windows_amd64.zip from the releases page, extract, and add to your PATH.
Verify Installation
Check that the CLI is installed correctly:
Authentication
Log in to connect the CLI to your HookWatch account:
Interactive Login (Default)
Run hookwatch login to enter your email and password.
After login, an API key is automatically created and stored in your config.
Browser Login
Use hookwatch login --browser to authenticate via your
browser. The CLI starts a local callback server and opens the dashboard login page.
API Key (Scripts & CI/CD)
Pass your API key with the global --api-key flag or
set HOOKWATCH_API_KEY environment variable.
Available Commands
| Command | Description |
|---|---|
hookwatch forward | Forward webhooks to localhost |
hookwatch ui | Open interactive TUI dashboard |
hookwatch cron | Manage cron jobs |
hookwatch endpoints | Manage webhook endpoints |
hookwatch events | View, replay, and export webhook events |
hookwatch alerts | Manage alert notifications |
hookwatch api-keys | Manage API keys |
hookwatch teams | Manage teams and members |
hookwatch agent | Manage CLI agents |
hookwatch ws | Manage WebSocket proxy endpoints |
hookwatch test | Send test webhooks |
hookwatch config | Manage CLI configuration |
hookwatch login | Authenticate with HookWatch |
hookwatch update | Update CLI to latest version |
hookwatch version | Print version information |
hookwatch uninstall | Uninstall the CLI |
hookwatch completion | Generate shell completions |
Run hookwatch --help or hookwatch <command> --help for detailed usage.
Shell Completion
Enable tab completion for your shell:
Bash
hookwatch completion bash > /etc/bash_completion.d/hookwatchZsh
hookwatch completion zsh > ~/.zsh/completions/_hookwatchFish
hookwatch completion fish > ~/.config/fish/completions/hookwatch.fishNext Steps
After installation, try hookwatch ui to launch the interactive dashboard, or hookwatch forward my-endpoint to start forwarding webhooks.