Install the CLI

The catchbin CLI is a single Go binary with no runtime dependencies. It runs on macOS, Linux, and Windows.

Install

Homebrew

brew install catchbin/tap/catchbin

curl

curl -fsSL catchbin.io/install.sh | sh

Manual

Download the archive for your platform from the GitHub releases page, extract the catchbin binary, and put it on your PATH.

Verify the install:

catchbin --version

Authenticate

The CLI authenticates with a workspace API key, which you create in the dashboard under your workspace settings.

1. Create an API key in the dashboard and copy it.

2. Run:

   catchbin configure

   The prompt is hidden — the key is not echoed to the terminal or written to your shell history. It is stored in your config file.

Caution

Treat a workspace API key like a password. Anyone with it can read your captured events and manage your endpoints. Revoke a key from the dashboard if it leaks.

Where configuration lives

catchbin configure writes to a per-user config file:

Platform	Path
macOS / Linux	~/.config/catchbin/config.yaml
Windows	%APPDATA%\catchbin\config.yaml

The file holds two keys, api_key and api_url. Environment variables override the file, which is useful in CI and for pointing the CLI at a non-default backend:

Variable	Overrides	Default
CATCHBIN_API_KEY	api_key	none
CATCHBIN_API_URL	api_url	https://api.catchbin.io

Output discipline

Every command writes data to stdout and diagnostics (status lines, reconnect notices, errors) to stderr. That means you can pipe event data through jq without status noise mixing in:

catchbin forward wk_<your-workspace>/stripe-dev localhost:3000 --json | jq

Commands exit non-zero on failure with a stable, documented code — see the CLI reference.