joppa.toml
El archivo joppa.toml comparte los procesos de un proyecto con el equipo. Su formato, campo por campo.
joppa.toml describe, en la raíz de un proyecto, los procesos que Joppa inicia. Haz commit de él: tus compañeros obtienen la misma configuración en cuanto añaden el proyecto. Cuando existe, es el que manda sobre la configuración local.
Joppa lo escribe por ti cuando marcas Escribir joppa.toml en el repositorio para el equipo en el análisis de los procesos. También puedes escribirlo a mano.
Ejemplo
[[procs]]
name = "postgres"
kind = "compose"
service = "db"
[[procs]]
name = "api"
kind = "script"
dir = "apps/api"
command = "bun run dev"
port = 8000
dependsOn = ["postgres"]
[procs.env]
PORT = "8000"
[[procs]]
name = "web"
kind = "script"
dir = "apps/web"
command = "bun run dev"
port = 5173
dependsOn = ["api"]
[[procs]]
name = "worker"
kind = "script"
command = "bun run queue"
enabled = false
Los campos
Cada [[procs]] es un proceso.
| Campo | Tipo | Función |
|---|---|---|
name |
texto | Nombre único en el proyecto: web, api, postgres |
kind |
"script" o "compose" |
Un comando, o un servicio del Docker Compose del proyecto |
port |
número | El puerto en el que responde una vez listo. Ausente para una tarea en segundo plano |
dependsOn |
lista | Procesos iniciados (y listos) antes que este |
enabled |
booleano | Se inicia con «Iniciar todo» (true por defecto). En false, se inicia por separado |
kind = "script"
| Campo | Función |
|---|---|
command |
El comando, ejecutado en un shell |
dir |
La carpeta, relativa a la raíz del proyecto (vacío: la raíz) |
env |
Variables de entorno añadidas ([procs.env]) |
kind = "compose"
| Campo | Función |
|---|---|
service |
El nombre del servicio en el archivo Docker Compose |
Lo que no incluye
Iniciar al abrir Joppa y Reiniciar tras un fallo son preferencias de cada máquina: se quedan en Joppa y nunca se escriben en joppa.toml.