CLI reference

List listening processes#

Running portpilot without a subcommand defaults to list.

portpilot list
portpilot list --start 3000 --end 9000
portpilot list --proto tcp
portpilot list --json

--proto accepts a protocol filter such as tcp or udp. Discovery is limited to what the operating system makes visible to the current user.

Find the owner of a port#

portpilot pid 3000
portpilot pids 3000 5432 8080

Use the process identity as context, not as a permanent handle. A process can exit and its PID can be reused.

Find an available port#

portpilot find --start 3000 --end 3100 --count 3
portpilot find --start 3000 --end 3100 --json

Availability is observed at the time of the check; another process can bind the port afterward.

Connections, schedules and the terminal UI#

portpilot connections
portpilot cronjobs --user-only
portpilot tui

cronjobs lists scheduled jobs; --system-only and --json are also available. tui launches the separately built portpilot-tui binary.

Process control#

portpilot pause 3000
portpilot resume 3000
portpilot kill 3000

kill attempts graceful termination with a default 5,000 ms timeout. --force requests forceful termination. Prefer ordinary termination when possible.

The full command help#

portpilot --help
portpilot list --help
portpilot proxy --help
portpilot blocklist --help

Other command groups include Docker information, program matching and an SSH SOCKS proxy. The CLI’s proxy is a different feature from the app’s local Quick Proxy. Use each command’s help for its options.