Commands
Complete reference for every fixedhook CLI command.
Every fixedhook command follows the same shape:
fixedhook <command> [flags]Run fixedhook --help for a live list, or fixedhook <command> --help for details on a specific command.
Global flags
| Flag | Description |
|---|---|
--help | Show help for any command |
--version | Print the CLI version and exit |
--json | Emit machine-readable JSON instead of pretty text |
--no-color | Disable ANSI color in output |
Authentication
fixedhook login
Sign in via the browser-based device flow. The command prints a URL and a code, waits for confirmation, and stores the API key in your OS keychain.
fixedhook loginfixedhook logout
Clear the stored API key. The next command that needs auth will prompt you to log in again.
fixedhook logoutfixedhook whoami
Print the email and plan of the currently authenticated account.
fixedhook whoamifixedhook upgrade
Self-update the CLI to the latest release. Downloads the binary for your platform, verifies its SHA256 checksum against the published manifest, and replaces the running binary in place.
fixedhook upgradeWorks on macOS, Linux, and Windows. The current version is also shown by fixedhook version, which prints an update notice when a newer release is available.
Aliases
fixedhook aliases list
List all aliases on your account. Output includes the subdomain, online status, and the public URL.
fixedhook aliases listFlags:
| Flag | Description |
|---|---|
--json | Output as JSON |
--offline | Show only offline aliases |
fixedhook aliases create
Create a new alias. The only required argument is the subdomain.
fixedhook aliases create my-app-devFlags:
| Flag | Description |
|---|---|
--display-name | A friendly name shown in the dashboard |
The subdomain must be 3–32 characters, alphanumeric with hyphens, and not on the reserved list. The CLI validates before sending the request.
fixedhook aliases delete
Delete an alias. The alias is removed and its public URL returns 404 from that point on. Existing event history is retained according to your plan's history window.
fixedhook aliases delete my-app-devYou will be prompted to confirm unless --yes is passed.
fixedhook aliases show
Print details for a single alias, including the current tunnel session (if any) and recent activity.
fixedhook aliases show my-app-devTunnel
fixedhook up
Start a tunnel. The most common invocation:
fixedhook up --port 3000 --alias my-app-devFlags:
| Flag | Description |
|---|---|
--port | Local port to forward to (required) |
--alias | Subdomain to attach to (required if no webhooks.yaml or matching name) |
--host | Local host to forward to. Defaults to 127.0.0.1 |
--config | Path to a webhooks.yaml file. Defaults to ./webhooks.yaml if present |
--name | Named alias from the config (alternative to --alias) |
--no-reconnect | Exit on the first disconnect instead of auto-reconnecting |
The CLI stays attached to the terminal. Press Ctrl+C to gracefully shut down the tunnel.
When the CLI is started without --alias or --name, it looks for a webhooks.yaml in the current directory. If exactly one alias is configured, it starts that one. Otherwise, the CLI prints a list of available names and exits.
fixedhook status
Print the state of the active tunnel session: alias, online status, current request rate, and uptime. Useful as a sanity check from another terminal.
fixedhook statusConfiguration
fixedhook config init
Scaffold a webhooks.yaml in the current directory. The file is pre-populated with a single alias entry you can customize.
fixedhook config initfixedhook config validate
Validate the webhooks.yaml in the current directory (or one passed via --file). The CLI prints any errors and exits non-zero if the file is invalid.
fixedhook config validatefixedhook config show
Print the active configuration, with defaults applied and the file path it was loaded from.
fixedhook config showEvents
fixedhook events list
List recent events for a given alias. Defaults to the last 24 hours and the most recent 50 events.
fixedhook events list --alias my-app-devFlags:
| Flag | Description |
|---|---|
--alias | Alias to list events for (required) |
--since | Filter to events after this time (e.g. 1h, 2024-01-01) |
--limit | Maximum number of events to return (default 50) |
--status | Filter by status: success, failed, queued |
--provider | Filter by provider (e.g. stripe, github) |
fixedhook events get
Print a single event in full detail, including request and response bodies.
fixedhook events get evt_01HQ2…fixedhook events replay
Trigger a replay for a single event. Requires a tunnel to be online, or the relay will queue the replay.
fixedhook events replay evt_01HQ2…Output formats
Most commands support --json for machine-readable output, which is useful for piping into other tools:
fixedhook aliases list --json | jq '.aliases[].subdomain'--json is a stable contract; the JSON shape mirrors the underlying HTTP API responses.