Documentation Index
Fetch the complete documentation index at: https://wsignal.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Synopsis
What It Does
wsignal dev loads config, ensures the storage directories exist, starts the local HTTP server, and begins receiving webhook requests.
Config Resolution
If you do not pass--config, wsignal searches the current working directory for:
wsignal.config.tswsignal.config.jswsignal.config.mjs
wsignal dev starts an interactive setup flow instead of failing immediately.
Terminal Behavior
When an interactive terminal reporter is available,wsignal renders a richer terminal UI.
Otherwise it prints a static startup summary and line-oriented runtime updates.
Request Lifecycle
For a matched static response or forwarding endpoint,wsignal:
- Reads the raw request body.
- Attempts JSON parsing for convenience.
- Builds an event object.
- Persists the event to JSONL.
- Sends the configured response back to the caller.
- Optionally forwards the event to one or more matching forward targets.
wsignal sends the request upstream, persists the event with the upstream status, and returns the upstream response to the caller.
If persistence fails, the request receives a 500 response and the event is not acknowledged as successful.
Update Notices
After startup,wsignal dev occasionally checks the npm registry for a newer CLI version. The check is non-blocking, throttled, and skipped in CI.
Disable passive update checks with:
Examples
Start with the default config:Common Use
dev is the command you keep running while:
- Testing local webhook integrations
- Capturing provider payloads for debugging
- Verifying response behavior
- Building replayable fixtures