CLI Overview

The WebhookRelay CLI provides command-line access to manage sources, destinations, routes, and tunnels.

Features

• Tunnel Management: Create secure tunnels to your local machine
• Resource Management: Create and manage sources, destinations, and routes
• Event Inspection: View and replay webhook events
• Authentication: Secure login with API keys or interactive auth

Quick Start

# Install the CLI
npm install -g webhookrelay-cli

# Login to your account
webhookrelay login

# Start a tunnel
webhookrelay tunnel --port 3000

Use Cases

Local Development

Receive webhooks on your local machine during development:

# Start your local server
npm run dev  # localhost:3000

# In another terminal
webhookrelay tunnel --port 3000
# Your public URL: https://abc123.tunnel.webhookrelay.com

CI/CD Integration

Automate webhook configuration in pipelines:

# Create source for CI
webhookrelay sources create \
  --name "GitHub CI" \
  --slug "github-ci" \
  --verification github \
  --secret "$GITHUB_WEBHOOK_SECRET"

# Create destination
webhookrelay destinations create \
  --name "Build Server" \
  --url "https://build.example.com/webhook"

# Create route
webhookrelay routes create \
  --name "GitHub to Build" \
  --source github-ci \
  --destination build-server

Event Debugging

Inspect and replay webhook events:

# List recent events
webhookrelay events list --limit 10

# View event details
webhookrelay events show evt_abc123

# Replay an event
webhookrelay events replay evt_abc123

Infrastructure as Code

Export and import configuration:

# Export current configuration
webhookrelay config export > webhookrelay.json

# Import configuration to new environment
webhookrelay config import webhookrelay.json

System Requirements

• Node.js 18.0 or later (for npm installation)
• macOS, Linux, or Windows
• Internet connection

Next Steps

• Installation - Detailed installation instructions
• Commands - Complete command reference
• Tunnels Guide - Using tunnels for local development