joppa 命令
安装 joppa 命令,从终端或脚本控制 Joppa:状态、服务、日志、数据库和代理,支持文本或 JSON 输出。
joppa 用于控制正在运行的应用。它能做的事与窗口相同,只是在终端或脚本中进行。
安装
设置 › 命令行 › 安装 joppa。Joppa 会为应用内附带的命令创建一个链接,尽可能放在 /usr/local/bin,否则放在 ~/.local/bin。如果该文件夹不在你的 PATH 中,设置中会给出需要添加到 ~/.zshrc 的那一行。
joppa version
命令
joppa # 终端中的全屏应用(TUI)
joppa status # 代理、CA、项目和域名、服务
joppa services # 服务及其状态
joppa start postgres # 启动一个服务
joppa stop redis # 停止一个服务
joppa logs postgres -n 200 -f # 日志,加 -f 持续输出
joppa dbs postgres # 数据库及其连接 URL
joppa proxy start # 或 stop
joppa open # 显示 Joppa 窗口
joppa mcp # MCP 服务器(见下文)
| 命令 | 别名 | 作用 |
|---|---|---|
joppa 或 joppa tui |
打开 TUI | |
joppa status |
st |
代理、CA、项目、域名及其健康状态、服务 |
joppa services |
svc |
服务及其状态 |
joppa start <service> |
启动一个服务 | |
joppa stop <service> |
停止一个服务 | |
joppa logs <service> |
log |
日志:-n / --lines N(默认 100)、-f / --follow |
joppa dbs <service> |
databases |
某个服务器上的数据库及其 URL |
joppa proxy start|stop |
启动或停止代理 | |
joppa open |
显示窗口 | |
joppa mcp |
在 stdio 上运行 MCP 服务器 | |
joppa help、joppa version |
帮助和版本 |
指定服务
你可以用任意方式指定服务:postgres、pg17、"PostgreSQL 17"、它的端口 5432 或它的标识符。
选项
| 选项 | 效果 |
|---|---|
--json、-j |
JSON 输出,供脚本使用(适用于所有命令) |
--launch |
如果 Joppa 未运行,则直接启动它,不再询问 |
--theme nuit|jour|auto |
TUI 主题 |
--no-motion |
关闭动画(或 JOPPA_NO_MOTION=1) |
-h、-v |
帮助、版本 |
在脚本中
# 需要时启动 Joppa,然后在测试前启动 PostgreSQL
joppa start postgres --launch
joppa services --json | jq .
退出码
| 代码 | 含义 |
|---|---|
0 |
成功 |
1 |
错误 |
2 |
命令或选项有误 |
3 |
Joppa 未运行 |
工作原理
应用会在其配置文件夹中写入一个 control.json 文件(包含一个端口和一个令牌,只有你可以读取)。命令通过它与应用的本地 API 通信。如果 Joppa 没有运行,joppa 会提示你并提议启动它。