CLI command reference

This page summarizes the main hooknexus commands. Run hooknexus <command> --help for full options.

Authentication

Command	Description
hooknexus login	Opens the browser for OAuth (GitHub / Google). Use --token for non-interactive login.
hooknexus logout	Clears the saved session locally.
hooknexus whoami	Prints the current user (if logged in).

Endpoints

Command	Description
hooknexus endpoints list	Lists your endpoints (alias: hooknexus endpoints ls).
hooknexus endpoints create	Creates an endpoint. Optional: --alias, --ttl (e.g. 7d).
hooknexus endpoints show <id>	Shows details for one endpoint.
hooknexus endpoints delete <id>	Deletes an endpoint (aliases: rm, remove).

Real-time monitoring

hooknexus listen <endpoint-id>

Streams incoming webhook requests for that endpoint over WebSocket. Use multiple IDs or hooknexus listen --all to monitor more than one endpoint.

Common options:

• --json — JSON lines per request
• --quiet — Minimal output

Local forwarding (Pro)

hooknexus forward <endpoint-id> --to http://localhost:3000/webhook

Forwards each captured request to your local URL. Requires a Pro (or higher) plan. See Local forwarding.

Request replay (Pro)

hooknexus requests replay <request-id> --to <url>

Re-sends a stored request to your target URL. Pro feature. List and inspect requests with:

• hooknexus requests list <endpoint-id>
• hooknexus requests show <request-id>
• hooknexus requests body <request-id>

Account and connection

There is no single status command. Use these instead:

Command	Description
hooknexus whoami	Confirms who is logged in.
hooknexus account	Account overview; use hooknexus account subscription for plan details.
hooknexus upgrade	Opens the pricing / checkout flow in the browser.
hooknexus config show	Shows API URL and other local settings.

Global options and output

The CLI does not use a --format flag. Output modes:

Option / env	Effect
--json	Machine-readable JSON where the command supports it (e.g. listen).
--quiet / -q	Shorter, quieter logs.
--no-color	Disables ANSI colors (also HOOKNEXUS_NO_COLOR).
-v, --version	Prints the CLI version.
-h, --help	Help for the program or subcommand.
HOOKNEXUS_DEBUG	Extra diagnostic output when debugging.

Tip

The shorthand hnx is available if your install exposes it (for example hnx listen with an endpoint ID).

Aliases

Some commands have short aliases, for example hooknexus endpoints ls, hooknexus forward as fwd, and hooknexus account subscription as sub. Use --help on each command for the exact aliases.