joppa.toml
joppa.toml 文件用于与团队共享项目的进程配置。本文逐个字段介绍它的格式。
joppa.toml 位于项目根目录,描述 Joppa 要启动的进程。请提交它:你的同事添加该项目后就能获得相同的配置。该文件存在时,它优先于本地配置。
当你在 进程 分析中勾选 在仓库中写入 joppa.toml,供团队共享 时,Joppa 会替你写入它。你也可以手动编写。
示例
[[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
字段
每个 [[procs]] 是一个进程。
| 字段 | 类型 | 作用 |
|---|---|---|
name |
文本 | 在项目中唯一的名称:web、api、postgres |
kind |
"script" 或 "compose" |
一条命令,或项目 Docker Compose 中的一个服务 |
port |
数字 | 就绪后响应的端口。后台任务不填 |
dependsOn |
列表 | 在此进程之前启动(并就绪)的进程 |
enabled |
布尔值 | 是否由「全部启动」启动(默认 true)。为 false 时只能单独启动 |
kind = "script"
| 字段 | 作用 |
|---|---|
command |
命令,在 shell 中运行 |
dir |
文件夹,相对于项目根目录(留空:根目录) |
env |
额外添加的环境变量([procs.env]) |
kind = "compose"
| 字段 | 作用 |
|---|---|
service |
Docker Compose 文件中的服务名称 |
不包含的内容
打开 Joppa 时启动 和 崩溃后重新启动 是每台机器各自的偏好设置:它们保存在 Joppa 中,永远不会写入 joppa.toml。