CLI Overview

The Hookie CLI authenticates against your running Hookie web app (Clerk), talks to your relay, and streams webhook events in real time.

Installation

Install from npm (prebuilt binaries) or build from source in the cli/ directory of the repository.

pnpm add -g @hookie-sh/hookie

npm install -g @hookie-sh/hookie

bun install -g @hookie-sh/hookie

After installation, verify it's working:

hookie --version

Quick Start

1. Run the web app and relay (see Self-hosting).

2. Authenticate — browser login against your app:

hookie login

Set HOOKIE_WEB_APP_URL if your app is not embedded in the CLI build (see the repo cli/README.md).

3. List applications:

hookie apps

4. Listen to webhook events:

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

Commands Overview

• Authentication - login and logout
• Applications - apps
• Topics - topics
• Listen - listen and anonymous mode
• Configuration - hookie.yml and env vars
• Init - init for interactive hookie.yml

Global Flags

• --org-id <org-id> - Organization scope for listen and init
• --debug or -d - Verbose output

Example:

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

Configuration

Global

Tokens and optional relay overrides live under ~/.hookie/ (or HOOKIE_CONFIG_DIR). Use hookie login / hookie logout.

Repository

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

Next Steps

• Self-hosting
• Authentication
• Listen