CLI Installation

Install the WebhookRelay CLI on your system.

npm (Recommended)

The easiest way to install the CLI is via npm:

npm install -g webhookrelay-cli

Verify installation:

webhookrelay --version

Binary Download

Download pre-built binaries for your platform:

macOS

# Intel
curl -fsSL https://releases.webhookrelay.com/cli/latest/webhookrelay-darwin-amd64 -o /usr/local/bin/webhookrelay
chmod +x /usr/local/bin/webhookrelay

# Apple Silicon
curl -fsSL https://releases.webhookrelay.com/cli/latest/webhookrelay-darwin-arm64 -o /usr/local/bin/webhookrelay
chmod +x /usr/local/bin/webhookrelay

Linux

# x64
curl -fsSL https://releases.webhookrelay.com/cli/latest/webhookrelay-linux-amd64 -o /usr/local/bin/webhookrelay
chmod +x /usr/local/bin/webhookrelay

# ARM64
curl -fsSL https://releases.webhookrelay.com/cli/latest/webhookrelay-linux-arm64 -o /usr/local/bin/webhookrelay
chmod +x /usr/local/bin/webhookrelay

Windows

# PowerShell
Invoke-WebRequest -Uri "https://releases.webhookrelay.com/cli/latest/webhookrelay-windows-amd64.exe" -OutFile "$env:USERPROFILE\bin\webhookrelay.exe"

# Add to PATH
$env:PATH += ";$env:USERPROFILE\bin"

Homebrew (macOS)

brew tap webhookrelay/tap
brew install webhookrelay

Docker

Run the CLI in a Docker container:

docker run -it webhookrelay/cli --version

# With persistent auth
docker run -it -v ~/.webhookrelay:/root/.webhookrelay webhookrelay/cli login

Authentication

After installation, authenticate with your account:

Interactive Login

webhookrelay login

This opens a browser for OAuth authentication.

API Key

For CI/CD or automated environments:

# Set via environment variable
export WEBHOOKRELAY_API_KEY="whr_live_abc123..."
webhookrelay sources list

# Or pass directly
webhookrelay --api-key "whr_live_abc123..." sources list

Configuration File

Create ~/.webhookrelay/config.json:

{
  "apiKey": "whr_live_abc123...",
  "organizationId": "org_xyz789",
  "apiUrl": "https://api.webhookrelay.com"
}

Configuration

Set Default Organization

# List organizations
webhookrelay orgs list

# Set default
webhookrelay config set organization org_xyz789

Configuration Options

Option	Environment Variable	Description
apiKey	WEBHOOKRELAY_API_KEY	API key for authentication
organizationId	WEBHOOKRELAY_ORG_ID	Default organization
apiUrl	WEBHOOKRELAY_API_URL	API base URL

View Configuration

webhookrelay config show

Updating

npm

npm update -g webhookrelay-cli

Binary

Re-download the latest binary using the commands above.

Homebrew

brew upgrade webhookrelay

Uninstalling

npm

npm uninstall -g webhookrelay-cli

Binary

rm /usr/local/bin/webhookrelay
rm -rf ~/.webhookrelay

Homebrew

brew uninstall webhookrelay

Troubleshooting

Command Not Found

Ensure the installation directory is in your PATH:

# Check PATH
echo $PATH

# Add to PATH (add to ~/.bashrc or ~/.zshrc)
export PATH="$PATH:/usr/local/bin"

Permission Denied

On macOS/Linux, you may need to make the binary executable:

chmod +x /usr/local/bin/webhookrelay

Authentication Failed

1. Verify your API key is valid
2. Check if the key has required permissions
3. Ensure you're using the correct organization

# Test authentication
webhookrelay whoami

Network Issues

If behind a proxy:

export HTTPS_PROXY=http://proxy.example.com:8080
webhookrelay login

Getting Help

# General help
webhookrelay --help

# Command-specific help
webhookrelay tunnel --help
webhookrelay sources --help