Skip to content

portler clean ​

Remove runtime files and release port reservations.

bash
portler clean [--ports] [--global] [--force]

Behavior ​

Plain portler clean removes the local .portler/ runtime files and releases this project's ports from the global registry (~/.portler/ports.json).

Clean refuses to run while services are running; pass --force to stop them first. This includes a Docker container that outlives its host supervisor, and a container whose liveness cannot be checked (for example, when the Docker daemon is unavailable). A surviving process group whose leader has exited also counts as running, even though its ownership cannot be verified. The same guard applies to --ports.

Options ​

FlagDescription
--portsOnly release this project's port reservations, keeping .portler/
--globalPrune stale entries left behind by crashed or deleted projects from the global registry (entries whose port is free again and that are more than five minutes old)
--forceStop running services first. With --global, explicitly reset an unreadable/corrupt global registry (pending not-yet-bound reservations may be lost).

Examples ​

bash
portler clean            # remove .portler/ + release this project's ports
portler clean --ports    # only release ports
portler clean --global   # machine-wide registry cleanup
portler clean --global --force  # recover an unreadable global registry
portler clean --force    # stop services, then clean

Released under the MIT License.