CLI

tigby tunnel

Expose a local server on an Identity's Tunnel

A Tunnel gives an Identity a public hostname on the Tunnel domain. The agent dials out, so nothing has to be open on the machine running this command. The connection authenticates with the Identity Key, which is shown once when the Identity is created.

tigby tunnel connect

Run the Tunnel in the foreground.

Connects the Identity's Tunnel and forwards every public request to a local port until Ctrl-C. Reconnects on its own with jittered backoff, and follows a planned handover without dropping requests that are in flight. With --json every event is one JSON document on a line of its own.

tigby tunnel connect [handle] [options]
ArgumentWhat it is
<handle>The Identity, with or without a leading @. Optional when the credential is an Identity Key. (optional)
OptionWhat it does
--port, -p <port>The local port to forward to.
--host <host>The local host to forward to. (default: 127.0.0.1)
--tcpShow the raw-TCP address rather than the URL; the bytes are forwarded the same way.
--identity-key <key>The Identity Key to connect with, when the profile holds an Admin Key. (TIGBY_IDENTITY_KEY)
--wire-url <url>The connect endpoint. Read off the Identity when not given. (TIGBY_WIRE_URL)
tigby tunnel connect @orderbot --port 3000
tigby tunnel connect @orderbot --port 5432 --tcp
TIGBY_IDENTITY_KEY=tigby_id_… tigby tunnel connect --port 3000 --json

tigby tunnel status

Show where a Tunnel is reachable.

The Tunnel's public hostname, both of its raw-TCP addresses – the allocated port when it has one, and the SNI collector – and the connect endpoint an agent dials. Whether anything is serving the Tunnel is answered by one request to the public hostname – which reaches the agent's own server when one is connected.

tigby tunnel status <handle> [options]
ArgumentWhat it is
<handle>The Identity, with or without a leading @.
OptionWhat it does
--identity-key <key>The Identity Key to read the Tunnel with, when no profile holds an API key. (TIGBY_IDENTITY_KEY)