CLI reference
Run wiretap <command> --help for the flags shipped by your installed version.
Core commands
Section titled “Core commands”| Command | Purpose |
|---|---|
wiretap config init |
Create the default configuration file |
wiretap gui |
Open the desktop dashboard; requires a GUI-enabled build |
wiretap tui |
Open the terminal dashboard |
wiretap version |
Print the embedded version |
wiretap completion <shell> |
Generate shell completion |
wiretap config init --force replaces an existing config file.
Interception
Section titled “Interception”| Command | Purpose |
|---|---|
wiretap intercept start |
Start proxy, local API, and an intercepted child shell |
wiretap intercept start --shell <kind> |
Select bash, fish, powershell, or gitbash |
wiretap intercept start --no-shell |
Run proxy and API without spawning a shell |
wiretap intercept trust-ca |
Install the local CA into system trust; may require elevation |
wiretap intercept stop |
Remove Wiretap-managed shell startup blocks |
Code export
Section titled “Code export”wiretap export targetswiretap export capture <capture-id> --as target[/client]wiretap export webhook <project> <webhook-id> --as target[/client]Examples:
wiretap export capture 42 --as shell/curlwiretap export webhook project-a 7 --as javascript/fetchwiretap export webhook project-a 7 --as python/requestsOmitting the client selects that target’s default. Exported snippets reproduce the request side of the exchange and omit hop-by-hop and Content-Length headers.
Relay registration
Section titled “Relay registration”wiretap relay \ --url https://relay.example.com \ --admin-token TOKEN \ register --name laptop --projects project-a,project-b --save--projects is optional. Use projects add later instead of re-registering.
Owner project commands
Section titled “Owner project commands”These use this desktop’s saved client credentials:
wiretap relay --url https://relay.example.com projects add <path>wiretap relay --url https://relay.example.com projects remove <path> --forceAdministrator commands
Section titled “Administrator commands”These require --admin-token:
wiretap relay clients listwiretap relay clients get <client-id>wiretap relay clients delete <client-id>
wiretap relay projects listwiretap relay projects reclaim <path> --client-id <client-id> --force
wiretap relay webhooks list <project>wiretap relay webhooks replay <project> <webhook-id>The desktop GUI exposes additional admin operations, including creating a client or project, moving project ownership, and deleting a single project.
Relay server binary
Section titled “Relay server binary”wiretap-relay -addr :8443 -db relay.db -admin-token TOKENThe matching environment variables are WIRETAP_RELAY_ADDR, WIRETAP_RELAY_DB, and WIRETAP_ADMIN_TOKEN.