@hookbase/cli
v2.2.0
Published
CLI tool for Hookbase - manage webhooks and localhost tunnels
Downloads
269
Maintainers
Readme
@hookbase/cli
The official CLI for Hookbase - manage webhooks, create localhost tunnels, and monitor deliveries from your terminal.
Installation
npm install -g @hookbase/cliQuick Start
# Login to your account
hookbase login
# Start a tunnel to receive webhooks locally
hookbase tunnels start 3000
# Or launch the interactive dashboard
hookbase dashboardFeatures
- Full API Access - Create and manage sources, destinations, routes, and more
- Localhost Tunnels - Expose local servers to receive webhooks during development
- Interactive Dashboard - Visual TUI with keyboard navigation
- Live Event Streaming - Watch webhook events in real-time
- Delivery Management - View, debug, and replay failed deliveries
- CI/CD Ready - JSON output and environment variable support
Commands
Authentication
hookbase login # Authenticate with Hookbase
hookbase logout # Clear credentials
hookbase whoami # Show current userResources
hookbase sources list # List webhook sources
hookbase sources create # Create a new source
hookbase destinations list # List destinations
hookbase destinations create # Create a destination
hookbase routes list # List routes
hookbase routes create # Create a routeTunnels
hookbase tunnels start 3000 # Create and connect a tunnel
hookbase tunnels list # List all tunnels
hookbase tunnels connect <id> <port> # Connect to existing tunnelEvents & Deliveries
hookbase events list # List recent events
hookbase events follow # Stream live events
hookbase deliveries list # List deliveries
hookbase deliveries replay <id> # Replay a failed deliveryAPI Keys
hookbase api-keys list # List API keys
hookbase api-keys create # Create a new API key
hookbase api-keys revoke <id> # Revoke an API keyInteractive Dashboard
hookbase dashboard # Launch TUI dashboardNavigate with Tab or number keys 1-6, use arrow keys to browse lists, Enter to select, and Esc to go back.
Environment Variables
HOOKBASE_API_KEY # API key for authentication
HOOKBASE_API_URL # Custom API URL
HOOKBASE_ORG_ID # Default organization IDCI/CD Usage
export HOOKBASE_API_KEY="whr_live_xxx"
hookbase sources list --json
hookbase deliveries bulk-replay --status failed --yesDocumentation
License
MIT
