CLI

portpilot CLI for status, ports, pairing, tunnels, Docker, and proxies.

The CLI binary is portpilot. Open a new shell after install so PATH and PORTPILOT_DATA_DIR apply.

Prerequisites

Agent running. On Linux you may need export PORTPILOT_DATA_DIR=/var/lib/portpilot in the same session as install.

Commands

portpilot status
portpilot doctor
portpilot ports
portpilot port <n>
portpilot health [port]
portpilot diagnose <port>
portpilot history [--search|--since|--before|--limit]
portpilot pair [CODE]
portpilot setup
portpilot unpair
portpilot tunnels [port]
portpilot expose <port> [--protocol]
portpilot tunnel stop
portpilot docker [containers|ports|container <id>]
portpilot proxy [list|show|routes]

Kill, firewall, and service actions are UI / dashboard surfaces, not CLI subcommands. There is no tunnel restart in the CLI.

portpilot doctor is the first stop when the agent looks unhealthy.

Expected result

Each command prints JSON-ish or tables from the local agent. Pairing uses the dashboard code.

Common problems

SymptomRecovery
portpilot not foundNew terminal; Windows PATH; Linux profile.d
Cannot find tokenPORTPILOT_DATA_DIR
Pair promptRun portpilot pair with the website code

Download PortPilot · FAQ · Support