PortMaster
Orquestador de entornos de desarrollo locales. Un archivo en la raíz del proyecto, un comando, y el stack entero arriba: puertos libres, Docker, backend y frontend, sin cuatro terminales abiertas.
Instalación
uv tool install portmaster
# o
pipx install portmaster
Requiere Python 3.10 o superior. Funciona en Windows, macOS y Linux.
Comandos
| Comando | Qué hace |
|---|---|
portmaster up |
Levanta el stack entero: libera puertos, arranca en orden y sigue los logs |
portmaster down |
Baja lo que sobrevive a la terminal, o sea contenedores |
portmaster serve |
Abre la interfaz web en http://127.0.0.1:7666 |
portmaster doctor |
Revisa qué puede impedir el arranque, sin arrancar nada |
portmaster ports |
Estado de los puertos declarados |
portmaster free 3000 |
Cierra el proceso que ocupa un puerto, preguntando antes |
portmaster free --all |
Lo mismo para todos los puertos de todos los proyectos registrados |
portmaster switch fitness |
Baja los proyectos que le pisan los puertos a este, y lo levanta |
portmaster open |
Abre en el navegador el primer servicio que conteste HTTP |
portmaster init |
Congela lo detectado en un stack.yaml editable |
portmaster add . |
Registra el proyecto para que aparezca en la interfaz |
portmaster list |
Lista los proyectos registrados (alias: ls) |
portmaster remove . |
Des-registra un proyecto (alias: rm) |
portmaster version |
Versión instalada (también --version) |
Cada uno con --help.
Arrancar un stack
portmaster up
portmaster up --profile backend # solo un subconjunto
portmaster up --no-free # no tocar los puertos ocupados
Antes de arrancar libera los puertos declarados que tenga otro proceso, y pregunta antes de cerrar cada uno. Los que ya publica Docker los saltea: ahí no hay nada que liberar, el contenedor ya está arriba.
demo stack.yaml
db | $ docker compose up -d postgres
db | listo (5432)
api | $ npm run dev
api | escuchando en 8080
api | listo (8080)
web | $ npm run dev
web | listo (3000)
Todo listo. Ctrl-C para apagar.
api | GET /health 200
web | ready in 412 ms
Antes de arrancar nada revisa los puertos declarados. Si alguno está tomado
por un proceso huérfano, muestra cuál es y pregunta si cerrarlo. Ctrl-C
apaga los servicios en orden inverso, árbol de procesos incluido.
Sin stack.yaml
stack.yaml es opcional. Si no hay uno, PortMaster mira la raíz del proyecto:
| Encuentra | Arranca |
|---|---|
compose.yaml, compose.yml, docker-compose.yml, docker-compose.yaml |
un servicio por contenedor: docker compose up -d <nombre> |
manage.py |
python manage.py runserver |
fastapi o uvicorn declarados, con un módulo que defina app |
uvicorn <módulo>:app --reload |
package.json con un script que sirva (dev, start:dev, serve, start) |
npm run dev, con pnpm/yarn/bun según el lockfile o el campo packageManager |
mi-app A:\Proyectos\mi-app
Sin stack.yaml. Detectado:
docker docker compose up -d 5433
web pnpm run dev al arrancar
Para congelarlo en un archivo editable: portmaster init
Arrancar? [Y/n]
Arranca en ese orden y encadena las dependencias: el frontend espera al backend, el backend a los contenedores.
portmaster init escribe lo detectado como stack.yaml para editarlo a mano.
No sobreescribe uno existente.
Dónde busca cada lenguaje y por qué reconoce eso y no otra cosa, en
docs/deteccion.md.
stack.yaml
En la raíz del proyecto. PortMaster lo busca hacia arriba, así que podés correr los comandos desde cualquier subdirectorio.
name: mi-proyecto
services:
db:
command: docker compose up -d postgres
port: 5432
detached: true # el comando termina, el servicio sigue vivo
api:
command: npm run dev
cwd: backend
port: 8080
needs: [db]
env:
DATABASE_URL: postgres://localhost:5432/app
web:
command: npm run dev
cwd: frontend
port: 3000
needs: [api]
profiles:
backend: [api] # arrastra db, que es su dependencia
command es el único obligatorio. La referencia de todos los campos, los
healthchecks de ready y los perfiles heredados de un compose están en
docs/stack-yaml.md.
Interfaz web
Cuando tenés varios proyectos, el CLI se queda corto: trabaja sobre el directorio actual. La interfaz los muestra todos a la vez.
portmaster serve # abre http://127.0.0.1:7666
Viene con la instalación, no hace falta nada más. Registrar proyectos se puede
desde la propia interfaz con Explorar…, o desde la terminal con
portmaster add ..
Estado de cada servicio, arrancar y apagar stacks, liberar puertos tomados por procesos ajenos, y logs en vivo por proyecto.
El detalle de cada control, y el modelo de seguridad del servidor local, en
docs/interfaz.md.
Puertos
Revisar el estado de los puertos sin arrancar nada:
portmaster ports # los declarados en stack.yaml
portmaster ports 3000 8080 # o los que le pases
PUERTO ESTADO PID PROCESO COMANDO
3000 ocupado 24188 node.exe node C:\proj\frontend\node_modules\.bin\vite
8080 libre - - -
5432 ocupado 9012 com.docker.backend.exe
Liberar un puerto tomado por un proceso zombie:
portmaster free 3000
Muestra qué proceso lo ocupa y pide confirmación antes de cerrarlo. Si decís que no, sugiere el siguiente puerto disponible.
Opciones: --yes salta la confirmación (para scripts), --force aplica
kill() cuando el proceso ignora la señal de terminación.
Después de un crash o un cambio de rama suele quedar más de uno colgado:
portmaster free --all
Recorre los puertos declarados por todos los proyectos registrados, lista lo que encuentre ocupado y pide una sola confirmación. Sale con código 1 si no pudo cerrar alguno.
El CLI no sabe qué arrancaste vos: si tenés un stack levantado en otra terminal, sus servicios aparecen en esa lista y también se cierran. Por eso la muestra entera antes de tocar nada, y por eso la confirmación viene con "no" por defecto. La interfaz web sí lo sabe, y ahí el botón "Liberar todos" descarta lo que arrancó ella.
Qué no hace el kill switch
Estas reglas están en el código, no en la documentación:
- Nunca cierra PID 0, PID 4, el propio PortMaster ni un proceso padre suyo. Matar tu propia terminal no es una función.
- Revalida la hora de creación del proceso entre el escaneo y el cierre. Los PID se reciclan; sin ese chequeo terminás matando algo al azar.
- Manda
terminate()y espera 5 segundos.kill()solo con--forceexplícito, porque unnpm run devmatado a lo bruto deja hijos huérfanos. - Sin permisos, lo dice y corta. No reintenta escalando privilegios.
- Nunca cierra el proxy de Docker o de WSL. Un puerto publicado por un contenedor no lo escucha el contenedor: lo escucha un proceso compartido por todos, y cerrarlo apaga el motor entero. En vez de eso te dice qué contenedor parar.
Otros comandos
down, switch, doctor y open, con qué revisa cada uno y por qué, en
docs/comandos.md.
Modelo de confianza
stack.yaml ejecuta comandos arbitrarios, igual que package.json o un
Makefile. PortMaster no lo sandboxea: sería teatro. Tratá un stack.yaml
de un repo ajeno con el mismo cuidado que sus scripts de build.
Sin stack.yaml, los comandos salen de la detección, y scripts.dev de un
package.json ajeno es igual de arbitrario. Por eso up muestra qué va a
ejecutar y pregunta antes, y -y es tuyo para saltarlo cuando ya lo leíste.
Desarrollo
python -m venv .venv
.venv/bin/pip install -e ".[dev]" # .venv\Scripts\pip en Windows
pytest
Los tests levantan sockets y procesos reales, sin mocks. Es lo único que prueba de verdad un módulo cuyo trabajo es hablar con el sistema operativo.
Licencia
MIT
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file portmaster-1.0.2.tar.gz.
File metadata
- Download URL: portmaster-1.0.2.tar.gz
- Upload date:
- Size: 132.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
714da746e2f0ceead27b510dd03c1dfb0fb42dca2f12d38e807dc8ad13f79a46
|
|
| MD5 |
e8721de45b17685532009509ef9a5aaa
|
|
| BLAKE2b-256 |
195e8be4546311f5398e5682a6b51b2dbe7cf3f1826deede0ad281d28020d482
|
Provenance
The following attestation bundles were made for portmaster-1.0.2.tar.gz:
Publisher:
release.yml on TicoraX/PortMaster
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
portmaster-1.0.2.tar.gz -
Subject digest:
714da746e2f0ceead27b510dd03c1dfb0fb42dca2f12d38e807dc8ad13f79a46 - Sigstore transparency entry: 2387189507
- Sigstore integration time:
-
Permalink:
TicoraX/PortMaster@eccb9f54f3b43d59fb3cd938b9a489a20f8d298d -
Branch / Tag:
refs/tags/v1.0.2 - Owner: https://github.com/TicoraX
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@eccb9f54f3b43d59fb3cd938b9a489a20f8d298d -
Trigger Event:
push
-
Statement type:
File details
Details for the file portmaster-1.0.2-py3-none-any.whl.
File metadata
- Download URL: portmaster-1.0.2-py3-none-any.whl
- Upload date:
- Size: 83.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
66fb57a00592cf006bdff91479b09b1c6f50bf2e0220056ddb8bca479717190e
|
|
| MD5 |
04fdca77e2c2dcfc603b1c5292ef483a
|
|
| BLAKE2b-256 |
ec51a3341b8663182609cdaef27eeb0404ffe3efafee36a173557edbe1a2ecf7
|
Provenance
The following attestation bundles were made for portmaster-1.0.2-py3-none-any.whl:
Publisher:
release.yml on TicoraX/PortMaster
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
portmaster-1.0.2-py3-none-any.whl -
Subject digest:
66fb57a00592cf006bdff91479b09b1c6f50bf2e0220056ddb8bca479717190e - Sigstore transparency entry: 2387189583
- Sigstore integration time:
-
Permalink:
TicoraX/PortMaster@eccb9f54f3b43d59fb3cd938b9a489a20f8d298d -
Branch / Tag:
refs/tags/v1.0.2 - Owner: https://github.com/TicoraX
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@eccb9f54f3b43d59fb3cd938b9a489a20f8d298d -
Trigger Event:
push
-
Statement type: