Decipher Tunnel CLI

Expose your local development server to the internet so Decipher can run tests against it.

Why

Decipher's test runner needs a publicly reachable URL to interact with your app. decipher-tunnel creates a secure tunnel from a public URL to your local machine using ngrok, so you can run Decipher tests without deploying.

Installation

npm install @decipher-sdk/decipher-tunnel -g

Commands

login

Authenticate with your Decipher account. Opens a browser window where you copy a token and paste it back into the terminal.

decipher-tunnel login

logout

Revoke your credentials and remove stored authentication.

decipher-tunnel logout

forward

Start a tunnel to expose a local port.

decipher-tunnel forward -p <port>

| Flag | Description | | --------------------- | ----------------------------------- | | -p, --port <number> | (required) Local port to tunnel |

While running, all proxied requests are logged:

[12:34:56] --> GET /api/users
[12:34:56] <-- 200 GET /api/users 42ms

Only one tunnel can be active at a time. Use kill to stop a running tunnel before starting a new one.

me

Show the currently authenticated user.

decipher-tunnel me

list

Show the active tunnel (public URL, local port, PID, start time).

decipher-tunnel list

kill

Stop the active tunnel.

decipher-tunnel kill

Requirements

• Node.js >= 18