Skip to content

Generated files

Project files: .portler/

Portler writes runtime files to .portler/ in the project directory:

text
.portler/state.json          last assignments and run metadata
.portler/runtime.env         resolved env snapshot
.portler/pids.json           pids of detached services and the proxy
.portler/logs/<service>.log  captured output of detached local services
.portler/k8s/                generated Kubernetes manifests

These files should not be committed:

text
.portler/

Notes:

  • Log files are written for services started with portler up -d, truncated on each restart, and kept after portler down for post-mortem inspection.
  • portler clean removes the whole .portler/ directory (refusing while services run, unless --force).
  • .portler/k8s/ is regenerated by portler up k8s and portler k8s render.

Global files: ~/.portler/

text
~/.portler/ports.json        global port registry (all projects on this machine)
~/.portler/ports.lock        lock file serializing port allocation

The registry records which project/service reserved which port, so concurrent portler up runs in different projects never hand out the same port. Stale entries (port free again, reservation old enough) are pruned automatically; portler clean --global forces a prune, and portler clean --ports releases the current project's reservations.

Released under the MIT License.