CLI reference
tunnelpad share
tunnelpad share <target> [options]
<target> is a port (8000), host:port, or a URL (https://acme.test).
| Option | |
|---|---|
--subdomain=<name> |
Choose the name (Pro, Team) |
--domain=<host> |
Serve at your own domain (Pro, Team). See Custom domains |
--auth=<user:password> |
Password-protect the tunnel |
--magic-auth[=<emails>] |
Ask visitors for their email first, optionally only some (@acme.com,jane@example.com) |
--qr |
Print a QR code of the public address |
--vite=<path> / --no-vite |
Share a Laravel project's Vite dev server too, or don't |
--no-dashboard |
Don't start the dashboard on 127.0.0.1:4040 |
--preserve-host |
Send the public host name to your app instead of the local one |
--inspect=<dir> |
Save every request and response as JSON files |
--server=<key or URL> |
Use another server (see tunnelpad servers) |
--token=<token> |
Use this token instead of the saved one |
--json |
Print events as JSON lines, for scripts and apps |
tunnelpad share-port
tunnelpad share-port <port or host:port> [--server=…] [--token=…] [--json]
Share a TCP port (Pro, Team). See TCP ports.
tunnelpad login
Sign in through your browser and save a token. --no-browser prints the link instead of opening it.
tunnelpad token
tunnelpad token [<token>] [--server=<URL>]
Save a token (and optionally a server), or show the saved one.
tunnelpad servers
List the servers you can share through. --json for scripts.
tunnelpad default-server
tunnelpad default-server [<key>]
Set the server tunnelpad share uses by default, or show it.
tunnelpad self-update
Update to the latest version. --check only says whether there's one.
Environment variables
| Variable | |
|---|---|
TUNNELPAD_TOKEN |
Token to use (instead of the saved one) |
TUNNELPAD_SERVER |
Server to use |
TUNNELPAD_AUTH |
Same as --auth, without putting the password on the command line |
TUNNELPAD_MAGIC_AUTH |
Same as --magic-auth |
TUNNELPAD_HOME |
Where settings are kept (default ~/.tunnelpad) |
TUNNELPAD_NO_UPDATE_CHECK |
Set to 1 to stop checking for new versions |