6. CLI 与代理联动
在终端里操作 Saba-chan,并让 Claude Code、Codex 这样的 AI 代理替你操作。
6. CLI 与代理联动
saba-chan-cli 是在终端里操作 Saba-chan 的工具。终端是输入命令的窗口。应用能做的事,CLI 都能做;CLI 和应用一样只是向守护进程提出请求,不会直接改动服务器文件。它方便人使用,也能输出便于机器读取的结果,所以你可以用它把 Saba-chan 交给自己的 AI 代理。
使用 CLI
CLI 位于 Saba-chan 的安装文件夹(默认 C:\Program Files\Saba-chan\saba-chan-cli.exe)。安装程序不会修改系统 PATH(Windows 查找命令的文件夹列表)。请用完整路径调用 CLI,或自己把该文件夹加入 PATH。在 Linux 上,安装程序会创建 ~/.local/bin/saba-chan-cli。
- 不带参数运行会打开交互式界面。
- 守护进程没在运行时,会问你要不要启动。关闭 CLI 后守护进程和服务器仍会继续运行。
- 服务器名称只写一部分也可以。
| 想做的事 | 命令 |
|---|---|
| 整体状态 | saba-chan-cli status |
| 添加服务器 | saba-chan-cli server add |
| 启动 · 停止 · 重启 | saba-chan-cli start 帕鲁 · stop 帕鲁 · restart 帕鲁 |
| 控制台 · 游戏命令 | saba-chan-cli console 帕鲁 · saba-chan-cli run 周末 say 你好 |
| 备份 · 计划任务 | saba-chan-cli backup … · saba-chan-cli schedule … |
| 连接 Discord | saba-chan-cli bot pair(显示代码并等待连接完成) |
| 命令权限 · 查看各等级的命令 | saba-chan-cli perm … · perm commands |
| Discord 确认步骤 | saba-chan-cli bot confirm |
| Discord 服务器前缀 · 斜杠命令样式 | saba-chan-cli bot prefix … · bot slash … |
| 会朗读的 Saba-chan · Discord 服务器管理 | saba-chan-cli bot tts … · bot moderation · bot channel … |
| 查看会说话的 Saba-chan 的工具 | saba-chan-cli chatbot tools(修改:chatbot set tools=[lol,pubg] --guild …) |
| 查看 · 断开已连接的 AI 代理(远程) | saba-chan-cli bot agent · bot agent --unlink |
| Saba-chan 更新 | saba-chan-cli update check · update apply |
| 远程守护进程 | saba-chan-cli remote … · 任意命令加 --daemon <名称>(远程守护进程) |
| 切换到应用 | saba-chan-cli gui |
| 删除我的全部数据 | saba-chan-cli bot erase |
| 详细帮助 | saba-chan-cli <命令> --help |
与你的 AI 代理联动
只要是能执行终端命令的 AI 代理,比如 Claude Code、Codex,都可以把 Saba-chan 交给它。代理像人一样接收用话语提出的请求,在后台运行 saba-chan-cli 并读取结果。
我的 AI 代理(如 Claude Code、Codex)
›
为了方便代理使用,CLI 遵守以下规则。
--json:标准输出只输出一个 JSON 文档。提示和进度输出到标准错误。失败时包含error、error_code以及(如果有的话)suggestions。- 退出码:
0成功,1失败,2用法错误或匹配到多个目标,3无法连接守护进程,4找不到目标,130已取消。 help --json:以 JSON 给出所有命令的树、参数、全局选项和退出码表。守护进程没运行也能用。让代理先读这个,而不是死记命令。--json-stream:耗时的操作(安装服务器、更新)每行输出一个 JSON 表示进度,最后一行是结果。events --json:逐行跟踪守护进程事件(服务器启动和停止、安装进度等)。do:守护进程开放的操作列表。用do 操作 --plan可以先看会改变什么再执行。
需要人亲自做的事
- 需要确认的命令在非终端环境下不会询问,而是停下来,必须加
--yes才会执行。在删除、重置服务器这类无法撤销的命令上加--yes之前,请让代理先问你。 - 同意游戏协议(EULA),以及同意不隔离运行未经验证的模块,不能用
--yes或--json代替。要由人在终端或应用里亲自完成。
可以粘贴到代理指令里的示例
在代理的指令文件(例如 AGENTS.md、CLAUDE.md)里写上类似下面的内容即可。路径请按你的安装位置修改。
## Saba-chan 游戏服务器
- 游戏服务器只用 saba-chan-cli 操作:"C:\Program Files\Saba-chan\saba-chan-cli.exe"
- 先用 `saba-chan-cli help --json` 读一遍命令和参数。
- 所有命令都加 --json,并检查退出码(0 成功,1 失败,2 用法或有歧义,3 没有守护进程,4 找不到目标)。
- 删除、重置服务器这类无法撤销的命令,先问人再加 --yes。
- 同意协议和解除隔离交给人来做。
远程连接 AI 代理(MCP)
即使 ChatGPT、Claude 这样的 AI 代理无法使用你电脑的终端,也可以通过远程 MCP 连接到 Saba-chan 云端,把你电脑上的游戏服务器交给它。它会像应用一样操作所有连接到你 Discord 账号的电脑。
- 在代理的连接器(远程 MCP 服务器)添加界面中填入
https://saba-chan.online/mcp。这个地址也可以在应用的 设置 → 连接 界面、/mysaba agent、saba-chan-cli bot agent中看到。 - 浏览器打开 Discord 登录页面后,用连接了电脑的 Discord 账号登录,并在 Saba-chan 的授权页面中允许。
- 用话语向代理提出请求。例如:“告诉我 Minecraft 服务器的状态”、“把 Palworld 服务器重新开起来”
小提示:
- 每个 Discord 账号只能连接一个代理。如果允许另一个代理,先前连接的代理会被断开。
- 危险命令以及停止、重启会在执行前于代理界面再次询问(与应用规则相同)。不会通过 Discord 询问。
- 在 Saba-chan 网页中被限制的事(路径、密码这类仅限电脑的设置,Saba-chan 更新等),也无法通过代理完成。
- 断开连接:应用的 设置 → 连接 界面的
断开代理连接、Discord 的/mysaba agent、saba-chan-cli bot agent --unlink。90 天未使用的连接会自动断开。