Command-line interface

Relayers CLI

relayers is the terminal companion to the desktop app. It opens a webhook tunnel from any provider — Stripe, GitHub, anything — straight to your localhost, with a URL that never expires. Same engine as the app, driven from your shell.

Install

On macOS or Linux, one line installs the latest relayers (amd64 or arm64, auto-detected) and verifies its checksum:

macOS · Linux
curl -fsSL https://dl.relayers.app/cli/install.sh | sh

It installs to /usr/local/bin when writable, otherwise ~/.local/bin. Override with RELAYERS_INSTALL_DIR. Prefer to read before you pipe to a shell? Open install.sh first.

Or download a binary

Extract the archive and put the relayers binary on your PATH. On Windows, unzip and add relayers.exe to your PATH. Checksums: checksums.txt.

Quickstart

Sign in, then point the tunnel at your local server:

1 · authenticate
relayers login
2 · start the tunnel
relayers listen --port 3000

Webhooks delivered to your Relayers endpoint now arrive at http://localhost:3000. The tunnel reconnects automatically and stays alive while idle — the same URL keeps working across restarts. Filter which endpoints a session listens to with --endpoints.

Commands

relayers login

Sign in with your Relayers email and password. Credentials are stored locally.

relayers listen --port 3000

Open the tunnel and forward incoming webhooks to http://localhost:3000. Flags: --host (default localhost), --name, --endpoints (comma-separated slugs/IDs).

relayers status

Show whether you're logged in and the current connection state.

relayers endpoints list

List your webhook endpoints. Also: create, delete.

relayers logs

View recent webhook events received on your account.

relayers install

Install relayers as a background service that keeps the tunnel up (see relayers service).

relayers version

Print the CLI version, commit, and build date.

Run relayers <command> --help for the full flags of any command.

Prefer a UI?

The desktop app does everything the CLI does — a live payload inspector, local forwarding rules, and a tray icon — on macOS, Windows, and Linux.

Download Relayers Desktop