CLI Overview

The Hookie CLI brings multiplayer webhooks to your machine: stream events from a shared URL, inspect payloads locally, and forward them to your dev server (or an agent session).

Installation

Install from npm (prebuilt binaries). Requires Node.js 18+. Supported platforms: macOS (amd64, arm64), Linux (amd64, arm64), Windows (amd64).

pnpm add -g @hookie-sh/cli

npm install -g @hookie-sh/cli

bun install -g @hookie-sh/cli

You can also run without a global install:

npx @hookie-sh/cli listen

After installation, verify the binary:

hookie --version

Quick Start

1. Authenticate (browser login via app.hookie.sh):

hookie login

2. List applications:

hookie apps

3. Listen for webhook events:

hookie listen --app-id <your-app-id>

For a temporary webhook URL without picking an app or source, run hookie listen with no flags. That creates an anonymous ephemeral channel, even if you are logged in.

Commands Overview

• Authentication — login and logout
• Applications — apps
• Sources — sources
• Listen — listen (authenticated or anonymous)
• Status — status (relay connectivity and login state)
• Configuration — init, hookie.yml, and environment variables

Shell completion: hookie completion <bash|zsh|fish|powershell>.

Global Flags

• --org-id <org-id> — Organization scope (used by listen, init, and related flows)
• --debug or -d — Verbose output (headers, query params, body, and more)
• --version or -v — Print version

Example:

hookie --org-id <org-id> apps

Configuration

Global

Tokens and machine ID live under ~/.hookie/ (or HOOKIE_CONFIG_DIR). Use hookie login / hookie logout.

Repository

Use hookie.yml for app_id, forward, and per-source URLs. See Configuration.

Next Steps

• Authentication
• Listen
• Configuration