Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
portcheck
command
Command portcheck shows what is using your ports, finds free ones, frees them up, and checks ports on remote hosts.
|
Command portcheck shows what is using your ports, finds free ones, frees them up, and checks ports on remote hosts. |
|
portcheck-tray
command
Command portcheck-tray shows the ports you're listening on in the macOS menu bar or the Windows/Linux system tray: who holds each one, and stop, open or copy from the menu.
|
Command portcheck-tray shows the ports you're listening on in the macOS menu bar or the Windows/Linux system tray: who holds each one, and stop, open or copy from the menu. |
|
internal
|
|
|
buildinfo
Package buildinfo reports the version, commit and build date of the running portcheck binary.
|
Package buildinfo reports the version, commit and build date of the running portcheck binary. |
|
cli
Package cli implements the portcheck command line interface.
|
Package cli implements the portcheck command line interface. |
|
cli/gendocs
command
Command gendocs writes portcheck's CLI reference as Markdown (for the docs site) and man pages.
|
Command gendocs writes portcheck's CLI reference as Markdown (for the docs site) and man pages. |
|
mcpserver
Package mcpserver serves portcheck to AI assistants over the Model Context Protocol (ADR-0007).
|
Package mcpserver serves portcheck to AI assistants over the Model Context Protocol (ADR-0007). |
|
nativehost
Package nativehost implements portcheck's side of browser native messaging (ADR-0005): the message framing, the allowlist of operations a browser extension may request, and registering portcheck with browsers.
|
Package nativehost implements portcheck's side of browser native messaging (ADR-0005): the message framing, the allowlist of operations a browser extension may request, and registering portcheck with browsers. |
|
output
Package output renders command results as tables, plain text, CSV or JSON.
|
Package output renders command results as tables, plain text, CSV or JSON. |
|
project
Package project loads a project's port configuration, .portcheck.yaml.
|
Package project loads a project's port configuration, .portcheck.yaml. |
|
testutil
Package testutil holds helpers shared by portcheck's tests.
|
Package testutil holds helpers shared by portcheck's tests. |
|
tray
Package tray is the logic of portcheck-tray, the menu bar (macOS) and system tray (Windows, Linux) app: which ports to show, and what each menu item does.
|
Package tray is the logic of portcheck-tray, the menu bar (macOS) and system tray (Windows, Linux) app: which ports to show, and what each menu item does. |
|
tui
Package tui implements portcheck's interactive terminal UI: a live, sortable, filterable table of sockets from which processes can be stopped.
|
Package tui implements portcheck's interactive terminal UI: a live, sortable, filterable table of sockets from which processes can be stopped. |
|
pkg
|
|
|
containers
Package containers attributes published ports to containers by asking a Docker-compatible Engine API (Docker, Docker Desktop, Colima, OrbStack, Podman) which host ports each running container publishes.
|
Package containers attributes published ports to containers by asking a Docker-compatible Engine API (Docker, Docker Desktop, Colima, OrbStack, Podman) which host ports each running container publishes. |
|
freeport
Package freeport determines whether local ports are free and finds free ones.
|
Package freeport determines whether local ports are free and finds free ones. |
|
inspect
Package inspect lists local network sockets together with the processes that own them.
|
Package inspect lists local network sockets together with the processes that own them. |
|
killer
Package killer terminates processes safely.
|
Package killer terminates processes safely. |
|
portspec
Package portspec parses and represents sets of TCP/UDP port numbers.
|
Package portspec parses and represents sets of TCP/UDP port numbers. |
|
scan
Package scan checks which TCP ports are reachable on remote hosts.
|
Package scan checks which TCP ports are reachable on remote hosts. |
|
waitfor
Package waitfor polls a condition until it holds or a context ends.
|
Package waitfor polls a condition until it holds or a context ends. |
|
wsl
Package wsl attributes ports forwarded from WSL (Windows Subsystem for Linux) to the distro and Linux process that listen on them.
|
Package wsl attributes ports forwarded from WSL (Windows Subsystem for Linux) to the distro and Linux process that listen on them. |
Click to show internal directories.
Click to hide internal directories.


