Reference

CLI

v0.1.0

Complete reference for the tunel, tuneld and tunelctl binaries.

The client. Run it on your machine to expose a local port to a public URL.

tunel start

Open a tunnel from a public URL to a local port. This is the default command — `tunel 3000` is shorthand for `tunel start 3000`.

Synopsis

tunel <port> [--subdomain=<name>] [--token=<tok>] [--region=<id>]

Flags

Flag	Type	Default	Description
--subdomain	string	random	Request a specific subdomain. Falls back to a random slug if taken.
--token	string	$TUNEL_TOKEN	Auth token. Reads the env var when omitted.
--region	string	auto	Edge region to terminate on, e.g. par, iad, fra.
--inspect	bool	true	Mirror traffic to the local inspector at 127.0.0.1:4040.
--host-header	string	preserve	Rewrite the Host header sent to your local service.

Examples

Expose a dev server

tunel 3000

Reserved subdomain on the Paris edge

tunel 8080 --subdomain=acme-staging --region=par

Rewrite Host for vhosted apps

tunel 3000 --host-header=app.local

Local inspector

Every request is replayable from http://127.0.0.1:4040 while the tunnel is open — including webhook payloads.

List, create and revoke the auth tokens tied to your account.

Synopsis

tunel tokens <list|create|revoke> [args]

Flags

Flag	Type	Default	Description
--name	string	—	Human label when creating a token.
--ttl	duration	0 (never)	Optional expiry, e.g. 720h.
--json	bool	false	Emit machine-readable JSON.

Examples

List tokens

tunel tokens list

Create a CI token that expires in 30 days

tunel tokens create --name=ci --ttl=720h

Revoke by id

tunel tokens revoke tok_8f3a21

Revocation is immediate

Revoked tokens are pushed to every edge node within ~1s and any live tunnel using them is torn down.

Print the client version, git commit and the negotiated protocol version.

Synopsis

tunel version [--json]

Example

Check version

tunel version
# tunel v0.1.0 (a1b2c3d) · protocol v1