@better-webhook/cli 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -364,6 +364,36 @@ better-webhook replay abc123 http://localhost:3000/webhooks \
364
364
 
365
365
  ---
366
366
 
367
+ ### `better-webhook dashboard`
368
+
369
+ Start the local **dashboard UI + API + WebSocket** server.
370
+
371
+ By default, this command starts:
372
+
373
+ - **Dashboard UI**: `http://localhost:4000/`
374
+ - **API**: `http://localhost:4000/api/*`
375
+ - **WebSocket**: `ws://localhost:4000/ws`
376
+ - **Capture server** (in-process): `http://localhost:3001/*`
377
+
378
+ ```bash
379
+ better-webhook dashboard [options]
380
+ ```
381
+
382
+ | Option | Description | Default |
383
+ | ------------------------- | ------------------------------- | ----------- |
384
+ | `-p, --port <port>` | Dashboard server port | `4000` |
385
+ | `-h, --host <host>` | Dashboard server host | `localhost` |
386
+ | `--capture-port <port>` | Capture server port | `3001` |
387
+ | `--capture-host <host>` | Capture server host | `0.0.0.0` |
388
+ | `--no-capture` | Do not start capture server | — |
389
+ | `--captures-dir <dir>` | Override captures directory | — |
390
+ | `--templates-dir <dir>` | Override templates base dir | — |
391
+
392
+ **Security note:**
393
+ Keep the dashboard bound to `localhost` unless you trust your network. The API includes endpoints that can send HTTP requests to arbitrary URLs (run/replay).
394
+
395
+ ---
396
+
367
397
  ## Environment Variables
368
398
 
369
399
  The CLI automatically reads webhook secrets from environment variables based on the provider: