Skip to main content

Command Reference

Complete reference of all Hooklistener CLI commands.

Global flags

These flags are available on all commands:

FlagDefaultDescription
--jsonfalseOutput as JSON (non-interactive commands only)
--log-levelinfoLog level: trace, debug, info, warn, error
--log-dir~/.config/hooklistener/logsCustom log directory
--log-stdoutfalseAlso output logs to stdout
--helpShow help
--versionShow version

Authentication

CommandDescription
hooklistener loginAuthenticate via device code flow
hooklistener login --forceForce re-authentication
hooklistener logoutSign out and clear stored token

Organization

CommandDescription
hooklistener org listList available organizations
hooklistener org use <id>Set default organization
hooklistener org clearClear default organization

Configuration

CommandDescription
hooklistener config showDisplay current configuration
hooklistener config set <key> <value>Set a config value

Endpoints

CommandDescription
hooklistener endpoint create <name>Create a debug endpoint
hooklistener endpoint listList debug endpoints
hooklistener endpoint show <id>Show endpoint details
hooklistener endpoint delete <id>Delete an endpoint

Flags: --slug, --org

Requests

CommandDescription
hooklistener endpoint requests <endpoint-id>List captured requests
hooklistener endpoint request <endpoint-id> <request-id>Show a request
hooklistener endpoint delete-request <endpoint-id> <request-id>Delete a request

Flags: --page, --page-size, --org

Forwarding

CommandDescription
hooklistener endpoint forward-request <endpoint-id> <request-id> <url>Forward a request
hooklistener endpoint forwards <endpoint-id> <request-id>List forwards
hooklistener endpoint forward <forward-id>Show forward details

Flags: --method, --page, --page-size, --org

Listen

CommandDescription
hooklistener listen <endpoint-slug>Forward webhooks in real time

Flags: --target / -t, --ws-url

Tunnel

CommandDescription
hooklistener tunnelStart an HTTP tunnel

Flags: --port / -p, --host, --org / -o, --slug / -s

Static tunnels

CommandDescription
hooklistener static-tunnel listList reserved slugs
hooklistener static-tunnel create <slug>Reserve a slug
hooklistener static-tunnel delete <id>Delete a slug

Flags: --name, --org

Shell completions

CommandDescription
hooklistener completions <shell>Generate completions

Shells: bash, zsh, fish, powershell, elvish

Maintenance

CommandDescription
hooklistener diagnosticsGenerate diagnostic bundle
hooklistener clean-logsRemove old log files

Flags: --output / -o, --keep / -k

Exit codes

CodeMeaning
0Success
1Error (authentication, connection, validation, etc.)