HookScope.Cli 1.2.1

HookScope CLI

Capture, inspect and forward webhooks from HookScope straight to your local machine — no tunnels, no hassle.

 _   _                   _      ____
| | | |   ___     ___   | | __ / ___|    ___    ___    _ __     ___
| |_| |  / _ \   / _ \  | |/ / \___ \   / __|  / _ \  | '_ \   / _ \
|  _  | | (_) | | (_) | |   <   ___) | | (__  | (_) | | |_) | |  __/
|_| |_|  \___/   \___/  |_|\_\ |____/   \___|  \___/  | .__/   \___|
                                                       |_|

Installation

dotnet tool install -g HookScope.Cli

Requires .NET 8 SDK or later.

Quick Start

# 1. Authenticate with your API key (found at hookscope.app → Settings)
hookscope login

# 2. Start forwarding webhooks to your local server
hookscope listen my-endpoint --to http://localhost:3000/webhook

# That's it — webhooks hitting hookscope.app/in/my-endpoint
# are now forwarded to your machine in real time.

Commands

hookscope login

Authenticate with your HookScope API key. Credentials are stored locally at ~/.hookscope/config.json.

# Interactive — prompts for API key
hookscope login

# Non-interactive — useful for CI or scripting
hookscope login --api-key sk_abc123...

# Custom environment (self-hosted or staging)
hookscope login \
  --api-key sk_abc123... \
  --api-url https://dev.hookscope.app/api/v1 \
  --collector-url https://dev.hookscope.app

hookscope listen <slug>

Connect to an endpoint via WebSocket and forward every incoming webhook to a local URL.

hookscope listen my-endpoint --to http://localhost:3000/webhook

# Short form
hookscope listen my-endpoint -t http://localhost:8080/api/hooks

Output:

── HookScope CLI ──────────────────────────────────
  Endpoint:  my-endpoint
  Forward:   http://localhost:3000/webhook
  Collector: https://hookscope.app
──────────────────────────────────────────────────
✓ Listening for webhooks...

14:32:01 POST    /                 (245 bytes)
           → 200 (12ms)
14:32:08 POST    /events/payment   (1,024 bytes)
           → 201 (34ms)

Press Ctrl+C to stop.

hookscope endpoints

List all your endpoints with status, forward mode and request count.

hookscope endpoints

◆ HookScope — Endpoints
╭─Endpoints────────────────────────────────────────────────────────────╮
│  Slug         Name           Status     Forward   Requests   Group  │
│  my-endpoint  Stripe Prod    ● Active   on        1,234      —      │
│  test-hook    Dev Testing    ● Active   proxy     56         team   │
│  old-ep       —              ● Paused   off       0          —      │
╰──────────────────────────────────────────────────────────────────────╯

hookscope endpoint <slug>

Interactive management for a single endpoint — toggle forward, change URL, pause/resume, and more.

hookscope endpoint my-endpoint

Available actions:

hookscope workflows

List all configured workflows across your endpoints.

hookscope workflows

hookscope plan

View your current plan, usage and limits.

hookscope plan

◆ HookScope — Plan & Usage

╭─Current Plan────╮
│  DEV             │
╰─────────────────╯

 Endpoints          2   5   ■■■■□□□□□□
 Workflows          1   2   ■■■■■□□□□□
 Daily Executions  45  1000 ■□□□□□□□□□

 Retention:           7 days
 Max Steps/Workflow:  3
 Member since:        2025-03-15

hookscope config

Show stored configuration (API URL, Collector URL, masked API key).

hookscope config

hookscope logout

Remove saved credentials from your machine.

hookscope logout

Common Workflows

Forward Stripe webhooks to local development

# Start forwarding
hookscope listen stripe-prod --to http://localhost:5000/api/billing/webhook

# In another terminal, check your endpoint status
hookscope endpoint stripe-prod

Check plan limits before creating new endpoints

hookscope plan
hookscope endpoints

Script-friendly login (CI/CD)

hookscope login --api-key "$HOOKSCOPE_API_KEY"
hookscope endpoints

Updating

dotnet tool update -g HookScope.Cli

Requirements

• .NET 8.0 SDK or later
• A HookScope account (free tier available)

About

HookScope is built by DevPlus — a software house based in São Paulo, Brazil.

hookscope.app · devplus.com.br