CLI Flags
Porthole includes several flags to customize your tunneling experience.
Global Options
Section titled “Global Options”--version
Section titled “--version”Show the current version of the Porthole CLI.
--help
Section titled “--help”Display help information for any command.
Start Command Flags
Section titled “Start Command Flags”These flags can be used when starting a tunnel (e.g., porthole 3000 --qr).
Opens the QR code modal immediately when the tunnel starts. Useful for quickly testing on mobile devices.
--name <name>
Section titled “--name <name>”Request a custom subdomain for your tunnel. If the name is already active, Porthole falls back to name-<random>.
--password <password>
Section titled “--password <password>”Protect your public tunnel with a password. Visitors will be prompted to enter this password before accessing your local service.
--verbose
Section titled “--verbose”Enable detailed logging. This is helpful for debugging connection issues or seeing full request/response details.
--no-telemetry
Section titled “--no-telemetry”Disable anonymous usage tracking. Porthole collects minimal, anonymous data to help improve the service.
Command Reference
Section titled “Command Reference”| Command | Argument | Description |
|---|---|---|
[port] | <number> | Starts a tunnel for the specified local port (default command) |
list | - | Lists all active tunnels (coming soon) |
stop | <id> | Stops a specific active tunnel (coming soon) |