后台化与停止 - start.sh 默认后台启动(AGENT_LOCAL_DETACH=1):拉起真正的启动器后 1 秒返回, 终端窗口可以关掉;停止统一走新增的 local/stop.sh(pid 文件 → core 父进程 → 占端口 三级兜底,幂等)。保留 AGENT_LOCAL_DETACH=0 前台模式。 - 「已在运行」改看 supervisor.pid(kill -0 + 命令行校验),health 只做兜底。 原来只看 health 时,core 尚未就绪的几秒内连跑两次会拉起两个启动器抢同一端口。 启动失败与首装体验 - 没 node 时在入口就拦下(生成配置之前),终端打出安装方式,不再让用户白选目录。 - 首次安装停在状态页等点击,后续启动才 2 秒自动跳转;状态页同一轮只开一个标签。 - 后台子进程秒退时改为指向状态页与日志路径,不再打印两行无意义的启动横幅。 其他修正 - MCP 默认端口 3101~3104 → 8091~8094;PORT 撞 MCP 端口直接拒绝启动。 - 没 ffmpeg 时不启动 mcp_asr(配置条目保留,装好后重跑即生效)。 - 依赖检测改为逐包检查 + .agent-installed 时间戳;npm install 输出落盘进状态页。 - app/package-lock.json 的 resolved 从腾讯云内网镜像改为公共 registry。 - 删除 local/start.command(Finder 双击常被当文本预览,入口统一为 start.sh)。 - 文档:docs/local-mode.md 补验证结果与新设计说明;local/README.md 改为启动/停止用法。
143 lines
7.5 KiB
Markdown
143 lines
7.5 KiB
Markdown
# 本地端(local 模式)
|
||
|
||
把同一个 `agent-core` 直接跑在本机(macOS / Linux),不装 Docker、不起 executor。
|
||
|
||
它和服务器版是**同一份代码**,差别只在三件事,全部由 `local/start.sh` 注入:
|
||
|
||
| 差异 | 服务器 | 本地 |
|
||
|---|---|---|
|
||
| 命令在哪跑 | `agent-executor` 容器(mount/pid namespace 隔离) | 直接在本机 `spawn`(无沙箱) |
|
||
| 文件工具的根 | 会话目录 `tasks/<会话id>/` | 你指定的工作目录 `workspace_root` |
|
||
| 监听地址 | `0.0.0.0`(靠宿主机端口映射对外) | `127.0.0.1`(只有本机能访问) |
|
||
|
||
后两项分别由环境变量 `AGENT_FILE_SCOPE=workspace` 和 `HOST=127.0.0.1` 控制,容器部署不设置,
|
||
行为与以前完全一致。
|
||
|
||
## 快速开始
|
||
|
||
```bash
|
||
cd agent
|
||
./local/start.sh # 后台启动,命令 1 秒就返回,可以关掉终端窗口
|
||
./local/stop.sh # 停止
|
||
```
|
||
|
||
首次运行会:
|
||
|
||
1. 自检环境(Node 20+ 必需;ffmpeg / python3 可选),并打开一个**启动状态页**
|
||
2. 弹窗让你选一个**工作目录**(AI 会在这个目录里干活)
|
||
3. 生成 `local/config.local.yml`
|
||
4. 装一次 Node 依赖(`app/` 与带依赖的 MCP,需要联网)
|
||
5. 起 core + MCP 子进程(没 ffmpeg 时 asr 不启动)
|
||
6. 停在那儿守护:core 退出就自动拉起
|
||
|
||
浏览器里首次使用:**左下角「用户区」→ 设置 → 模型池**,添加平台和 API Key,然后点「重启」。
|
||
|
||
没有 Node 20+ 时不会让你白选目录:脚本在入口就停下,终端打出安装方式,自检结果(哪项缺、怎么装)写到状态页。
|
||
|
||
> 「重启」能用是因为启动器在守护。`routes/system.js` 的重启实现是 `process.exit(0)`,
|
||
> 原本靠 Docker 的 restart 策略拉起;本地没有 Docker,没有守护的话点一次服务就回不来了。
|
||
|
||
启动器在后台常驻,所以:
|
||
|
||
- 关掉终端窗口**不会**停服务;要停就 `./local/stop.sh`
|
||
- 重复跑 `./local/start.sh` 是安全的:检测到已在运行就只打印地址和停止方式
|
||
- 想在终端里看实时日志、用 `Ctrl-C` 停:`AGENT_LOCAL_DETACH=0 ./local/start.sh`
|
||
|
||
## 启动状态页
|
||
|
||
启动时会在浏览器打开 `local/.runtime/status.html`(macOS 默认自动弹,Linux 要 `AGENT_LOCAL_UI=1`):
|
||
|
||
- 启动过程中每秒自动刷新,依次列出环境自检、工作目录、依赖安装、MCP、core 就绪
|
||
- 长步骤(装依赖、等 core 起来)会显示已用时间,并把 npm / core 日志的尾巴实时刷出来
|
||
- **首次安装**(配置刚生成)不自动跳转:就停在这一页,点「打开应用」自己进去
|
||
- **后续启动**:就绪后 2 秒自动进应用(同一个标签页)
|
||
- **失败时就在页面上给出原因和日志**,不用回头翻终端
|
||
|
||
这个页面是纯静态文件(不用起服务),所以“node 都没装”的时候也能打开。重跑脚本会重新生成;
|
||
即使没自动弹出,文件也一直在那个路径。
|
||
|
||
## 可选能力
|
||
|
||
| 能力 | 需要 | 没有时的表现 |
|
||
|---|---|---|
|
||
| 语音输入 | `ffmpeg` + 设置页给 `asr` 填上游(`X-ASR-Base-Url` / `X-ASR-Model`) | 麦克风入口自动隐藏(`/api/asr/status` 返回 `enabled:false`),`mcp_asr` 子进程也不启动 |
|
||
| 技能 | `python3` | 技能清单为空,其余功能不受影响 |
|
||
| 网页搜索 | 无 | 装了 Node 就有(内置免费后端) |
|
||
| 图片 / 视频生成 | 设置页给对应 MCP 填上游 key | 调用时报明确的缺参错误 |
|
||
|
||
装完 `ffmpeg` / `python3` 之后**重跑一次 `./local/start.sh`** 即可生效——这两项都不写进配置,
|
||
靠「起不起子进程 / 软链指向哪 / 注入什么环境变量」切换。
|
||
|
||
## 配置放哪
|
||
|
||
- 生成的配置:`local/config.local.yml`(**首次生成,之后永不覆盖**,避免冲掉你在网页里配的模型与密钥)
|
||
- 会话数据:`data/`(SQLite + prompt dump)与工作目录下的 `task-YYYYMMDD-NNN/`
|
||
- 运行期产物:`local/.runtime/`(`status.html` 状态页、`core.log`、`npm-install.log`、各 MCP 日志、技能软链)
|
||
|
||
想彻底重来:删掉 `local/config.local.yml`(以及可选的 `data/`)再启动。会话目录里的产出不会被删。
|
||
|
||
## 常用环境变量
|
||
|
||
| 变量 | 默认 | 说明 |
|
||
|---|---|---|
|
||
| `PORT` | `8090` | core 端口(别撞下面的 MCP 端口) |
|
||
| `NPM_REGISTRY` | 空 | 首次装依赖时用的 npm 源,如 `https://registry.npmjs.org` |
|
||
| `MCP_WEB_PORT` / `MCP_IMAGE_PORT` / `MCP_VIDEO_PORT` / `MCP_ASR_PORT` | 8091~8094 | 四个 MCP 的端口(同机跑必须各占一个;改这里还要同步改配置里的 url) |
|
||
| `AGENT_LOCAL_UI` | `auto` | 是否自动打开状态页:`auto` = 仅 macOS,`1` 强制,`0` 关闭(页面无论如何都会生成) |
|
||
| `AGENT_LOCAL_DETACH` | `1` | `1` = 后台启动后立即返回(用 `stop.sh` 停);`0` = 前台阻塞(看实时日志、`Ctrl-C` 停) |
|
||
|
||
## 更新
|
||
|
||
```bash
|
||
git pull
|
||
./local/stop.sh && ./local/start.sh # package.json 变了会自动重装依赖
|
||
```
|
||
|
||
`app/server` 是直接跑源码,前端也是免构建的,所以改完代码重启(或在网页点「重启」)即生效。
|
||
|
||
## 安全边界(务必知情)
|
||
|
||
本地模式**没有沙箱**:AI 的 `terminal` 就是本机 shell,能读写你账号有权限的任何文件,
|
||
包括 `~/.ssh`、浏览器数据、其它项目。这不是配置疏漏,而是「给它一个目录就放开手脚」的代价。
|
||
|
||
两条低成本保险:
|
||
|
||
1. 工作目录选一个**专用**目录,别直接选 `$HOME` 或整个代码仓库根
|
||
2. 那个目录先 `git init` 一下,改坏了能回滚
|
||
|
||
另外,`core` 只监听 `127.0.0.1`,同一局域网的人访问不到。
|
||
|
||
## 已知限制
|
||
|
||
- **没 ffmpeg 时 core 日志会有一条 `asr 工具发现失败`**:此时 `mcp_asr` 不启动(它转码要靠
|
||
ffmpeg),但配置里的 asr 条目仍保留(配置不被覆盖)。重试几次后放弃,不影响其它功能。
|
||
- **`mcp_asr` 启动后监听 `0.0.0.0`**:它只认 `PORT` 环境变量,没有 `--host` 参数
|
||
(另外三个服务都传了 `--host 127.0.0.1`)。它不存任何密钥(上游参数随请求带入),
|
||
暴露面有限,但严格起见可以给 `mcp/asr` 补一个 `--host` 支持。
|
||
- **Windows 暂不支持**:本机执行走 `spawn('/bin/sh')` 与 `process.kill(-pid)`,都是 POSIX 语义。
|
||
- **`mint_public_link` 不可用**:`public_link.base_url` 未配置(本地生成的链接只有本机能打开),
|
||
模型调用该工具会得到明确的「未配置」错误。
|
||
- **技能依赖**:有 `requirements.txt` 的技能需要自己把包装进 `skills/deps`
|
||
(服务器上这一步由 `agent-executor-init` 在构建期完成)。默认只保证纯标准库技能可用。
|
||
- **首个 `npm install` 要联网**:源不可达时换一个重跑:
|
||
`NPM_REGISTRY=https://registry.npmjs.org ./local/start.sh`。中途失败留下的半成品 node_modules
|
||
不用手删,下次启动会重新检测缺失的包。
|
||
|
||
## 排查
|
||
|
||
```bash
|
||
open local/.runtime/status.html # 启动状态页:步骤、失败原因、日志尾巴
|
||
tail -f local/.runtime/core.log # core 日志(含 prompt dump 路径、MCP 发现结果)
|
||
tail -f local/.runtime/npm-install.log # 装依赖的输出
|
||
tail -f local/.runtime/mcp-asr.log # 单个 MCP 的日志
|
||
```
|
||
|
||
启动失败时状态页会自己弹出(带错误说明和日志尾部);它是个静态页,所以改完环境要自己重跑脚本
|
||
(它不会自动重试)。
|
||
|
||
进程表 / 端口对不上时:
|
||
|
||
```bash
|
||
lsof -nP -iTCP:8090-8094 -sTCP:LISTEN # core + 四个 MCP 的监听情况
|
||
```
|