Flags for otterkit tunnel and otterkit webhook. For the other commands, see their own pages or run otterkit <command> --help.
Tunnels and webhooks#
| Flag | Description | Default |
|---|---|---|
--daemon | Run in the background | off |
--ttl <duration> | Auto-stop after e.g. 45m, 4h, 3d, or "never" | 24h |
--subdomain <name> | Use a stable URL, reserved to your account on first use | random name |
--json | Print the result as JSON (requires --daemon) | off |
Tunnel only#
| Flag | Description | Default |
|---|---|---|
--host <host> | Local host to forward to | 127.0.0.1 |
--log | Capture requests to a local JSONL log for inspect and replay | on |
--no-log | Turn off traffic capture | off |
--auth <user:pass> | Require HTTP Basic auth, checked locally | off |
Webhook: response#
| Flag | Description | Default |
|---|---|---|
--respond <status> | Auto-response status | 200 |
--respond-body <data> | Auto-response body | {"received":true} |
--respond-content-type <type> | Auto-response Content-Type | application/json, or guessed from the body |
--respond-header <name:value> | Extra response header (repeatable, max 16) | none |
--respond-delay <ms> | Delay before answering, max 10000 | 0 |
--respond-match <k=v> | Make the --respond* flags a conditional rule (repeatable) | off |
--respond-script <code|@file> | Compute the response per request in a sandboxed isolate | off |
Webhook: verification and inbox#
| Flag | Description | Default |
|---|---|---|
--verify <provider:secret> | Check each request's provider signature on arrival (16 providers) | off |
--verified-only | Rules created by this command fire only on valid signatures (needs --verify) | off |
--email | Add an inbox at <subdomain>@otterkit.app | off |
--claim <code> | Continue a webhook started on the /try page | off |
Webhook: forwarding#
| Flag | Description | Default |
|---|---|---|
--forward <url> | Deliver matching requests to this URL, signed, with retries | off |
--match <k=v> | Filter for --forward: method=, path=, or a JSON dot-path (repeatable) | all requests |
--forward-transform <tpl> | Deliver a rendered template instead of the raw capture (@file reads from disk) | JSON envelope |
--forward-script <code|@file> | Run JavaScript per match in a no-network isolate (50 ms CPU). The return value is the body; null skips. Cannot combine with --forward-transform | off |
--forward-content-type <type> | Content-Type of the transformed delivery | application/json |
Webhook: notifications#
| Flag | Description | Default |
|---|---|---|
--notify-email | Email on arrivals, at most 1 per 15 minutes | off |
--notify-match <k=v> | Email when a matching request arrives (repeatable) | off |
--notify-push [k=v] | Push to your enabled devices, at most 1 per minute per rule (repeatable) | off |
Webhook: local delivery#
| Flag | Description | Default |
|---|---|---|
--deliver <target> | Mirror every capture to a local port, host:port, or URL | off |
--deliver-exec <cmd> | Run a shell command per capture: body on stdin, metadata in OTTERKIT_* variables | off |