192 lines
14 KiB
Markdown
192 lines
14 KiB
Markdown
# 运行手册
|
|
|
|
> 怎么把 zcbot 跑起来。env / 常用命令 / 故障兜底。设计看 `DESIGN.md`,进度看 `PROGRESS.md`。
|
|
|
|
最后更新:2026-05-19(dev SPA 登录改 邮箱+密码;`POST /v1/auth/login_password`;`main.py user add` CLI)
|
|
|
|
---
|
|
|
|
## 环境
|
|
|
|
- **Python**:虚拟环境 `.venv/`,所有依赖装在里面。一律用 `.venv/Scripts/python.exe ...`(Windows)/`.venv/bin/python ...`(Unix),不要全局 `python`(litellm/python-pptx 等会 ModuleNotFoundError)。
|
|
- **配置文件 `.env`**(项目根,git 忽略,litellm 自动加载):
|
|
```
|
|
DEEPSEEK_API_KEY=sk-...
|
|
ZCBOT_DB_URL=postgresql://user:pass@host:5432/zcbot
|
|
# main.py web 必填(probe/db/user 不验)
|
|
PLATFORM_KEY=<≥16 字符随机串,platform 机器对机器入口校验>
|
|
JWT_SECRET=<≥32 字符随机串,HS256 签 session token;泄漏 = 任意伪造>
|
|
# 可选:覆盖默认 7d JWT TTL
|
|
# ZCBOT_JWT_TTL_SECONDS=604800
|
|
```
|
|
> litellm 在 import 时副作用加载 .env;入口走 `main.py`,`.env` 自动生效。直跑 `python -c "from core.storage import ..."` 不经 litellm 链路时记得自己 `import litellm` 触发,或手动 `export ZCBOT_DB_URL=...`。
|
|
- **依赖**:`pip install -r requirements.txt`(已在 `.venv` 里;含 `bcrypt`)。
|
|
- **PG**:`ZCBOT_DB_URL` 必填。本地 docker compose / 远端 dev / 生产任选;未设置时启动清晰报错,不引导 docker(§7.4)。
|
|
- **Auth env**:`PLATFORM_KEY` + `JWT_SECRET` 任一缺失 web 启动 fail-fast。生成随机串:`python -c "import secrets; print(secrets.token_urlsafe(48))"`。
|
|
- **用户管理**(`users.email/password_hash`,0005 UNIQUE(email)):dev SPA 登录后端。发用户走 `main.py user add`(下方);撤用户 `DELETE FROM users WHERE email=...`(先 DELETE 该 user 的 tasks)。改密 / 改邮箱手动 SQL 或先 DELETE 再 add。
|
|
|
|
---
|
|
|
|
## 一次性初始化
|
|
|
|
```bash
|
|
# 1) 装依赖(若 .venv 不在)
|
|
python -m venv .venv
|
|
.venv/Scripts/python.exe -m pip install -r requirements.txt
|
|
|
|
# 2) 准备 .env(见上)
|
|
|
|
# 3) DB schema 上车
|
|
.venv/Scripts/python.exe main.py db upgrade head
|
|
.venv/Scripts/python.exe main.py db current # 应输出 0005 (head)
|
|
```
|
|
|
|
---
|
|
|
|
## 日常命令
|
|
|
|
> 入口 `main.py {web, db, probe, user}`。所有 task / 消息 / 文件交互走 `main.py web` 起服务后浏览器(dev SPA)或 platform 端 / curl 调 `/v1/*`。
|
|
|
|
### Web 服务
|
|
|
|
```bash
|
|
# 默认 127.0.0.1:8765;dev SPA 在 /,Swagger UI 在 /docs
|
|
.venv/Scripts/python.exe main.py web
|
|
.venv/Scripts/python.exe main.py web --port 9000
|
|
.venv/Scripts/python.exe main.py web --reload # 文件改动自动重启
|
|
```
|
|
|
|
### DB / probe / user
|
|
|
|
```bash
|
|
# 模型能力对账(费 token)
|
|
.venv/Scripts/python.exe main.py probe --model deepseek_v4.flash
|
|
|
|
# DB migration
|
|
.venv/Scripts/python.exe main.py db upgrade head
|
|
.venv/Scripts/python.exe main.py db downgrade -1
|
|
.venv/Scripts/python.exe main.py db current
|
|
|
|
# 发用户
|
|
.venv/Scripts/python.exe main.py user add --email alice@example.com --password "atLeast6"
|
|
# → [ok] user added email=alice@example.com user_id=<uuid>
|
|
|
|
# 可选:把已有 user_id(platform_key 入口创的)接到邮箱密码路径
|
|
.venv/Scripts/python.exe main.py user add --email bob@x.com --password "s3cret" --user-id <UUID>
|
|
|
|
# 撤用户:先清 tasks(messages CASCADE)再 DELETE user
|
|
# psql> DELETE FROM tasks WHERE user_id=(SELECT user_id FROM users WHERE email='alice@example.com');
|
|
# psql> DELETE FROM users WHERE email='alice@example.com';
|
|
```
|
|
|
|
### Auth + curl 用 token 调 /v1/*
|
|
|
|
两条 login 路径,签**同款 JWT**。所有 `/v1/tasks*` 需 `Authorization: Bearer <jwt>`。
|
|
|
|
```bash
|
|
# 路径 1:邮箱密码(dev SPA / 同事试用 — 推荐)
|
|
curl --noproxy '*' -s -X POST http://127.0.0.1:8765/v1/auth/login_password \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"email":"alice@example.com","password":"atLeast6"}'
|
|
|
|
# 路径 2:platform_key + 指定 user_id(机器对机器)
|
|
curl --noproxy '*' -s -X POST http://127.0.0.1:8765/v1/auth/login \
|
|
-H "Content-Type: application/json" \
|
|
-d '{"user_id":"<UUID>","platform_key":"<value of $PLATFORM_KEY>"}'
|
|
|
|
# 调 /v1/*
|
|
TOKEN="eyJ..."
|
|
curl --noproxy '*' -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8765/v1/tasks
|
|
```
|
|
|
|
**dev SPA**:打开 `http://127.0.0.1:8765/`(自动 302 → `/static/dev.html`),登录页两 tab(默认"邮箱密码",备用"UUID + PLATFORM_KEY",last-used 持久化 LS)进入 3 栏(task / chat / files)。给同事试用:`main.py user add` 发用户,**不用重启** web(每次 login 都查 DB),把 URL + 邮箱密码分别发给同事。
|
|
|
|
### 路由表
|
|
|
|
全 JSON,CORS `allow_origins=["*"]`;详细 schema 见 `/docs`。
|
|
|
|
| 方法 + 路径 | 用途 | Auth |
|
|
|---|---|---|
|
|
| `GET /healthz` | `{"status":"ok"}` | 豁免 |
|
|
| `GET /` | 302 → `/static/dev.html` dev SPA | 豁免 |
|
|
| `GET /docs` `/openapi.json` | Swagger UI / OpenAPI schema | 豁免 |
|
|
| `GET /static/*` | dev.html 等静态文件 | 豁免 |
|
|
| `POST /v1/auth/login` | platform 机器对机器;body `{user_id, platform_key}` → `{token,expires_at,user_id,ttl_seconds}` | 豁免 |
|
|
| `POST /v1/auth/login_password` | dev SPA 邮箱密码;body `{email, password}` → `{token,...,email,...}`;邮箱不存在 / 密码错 / 未设密码统一 403 | 豁免 |
|
|
| `POST /v1/tasks` | 创建 task,body `{name(req), working_dir?, description?, skill?}` | 必填 |
|
|
| `GET /v1/tasks?page=&page_size=&status=&skill=&working_dir=&q=&ordering=` | 列任务,默认 `-created_at`;响应 `{page, page_size, count, results}`;`ordering` DRF 风格逗号分隔 `-field` 倒序,allowlist created_at/updated_at/name/status | 必填 |
|
|
| `GET /v1/tasks/{id}` | 单 task meta + `n_messages`;跨 user → 404 | 必填 |
|
|
| `PATCH /v1/tasks/{id}` | `{status?,description?,name?,skill?}`;active 不让从 web 切回 | 必填 |
|
|
| `DELETE /v1/tasks/{id}` | 硬删 DB 行(messages CASCADE),FS working_dir 保留 | 必填 |
|
|
| `GET /v1/folders` | 列当前 user 工作目录 + n_tasks + last_used | 必填 |
|
|
| `GET /v1/tasks/{id}/messages` | LiteLLM payload 透传 | 必填 |
|
|
| `POST /v1/tasks/{id}/messages` | `{content}` 发消息;返 `{events_url}`;**`run_status` 是 running/cancelling → 409**(单活 run;error 起新 run 时清);UI 应 disable send 直到 SSE `done` | 必填 |
|
|
| `GET /v1/tasks/{id}/events` | SSE 流(`event: <type>` + `data: <json>`);订阅 task 当前活动 | 必填 |
|
|
| `POST /v1/tasks/{id}/cancel` | 协作式 cancel;`run_status != running` → 409;LLM 同步 call 不可中断,最坏等当前一轮跑完 | 必填 |
|
|
| `GET /v1/files?path=` | 列 user_root 下条目 + 面包屑;dotfile 隐藏 | 必填 |
|
|
| `GET /v1/files/download?path=` | 下单文件 | 必填 |
|
|
| `POST /v1/files/upload` | multipart 上传到 `<user_root>/<path>/`;路径不存在自动 mkdir,重名覆盖 | 必填 |
|
|
| `POST /v1/files/delete` | `{path}`;文件或空目录;**path 顶层目录且被 task 引用 → 409**,先 DELETE 关联 task | 必填 |
|
|
| `POST /v1/files/rename` | `{path, new_name}`;sibling 已存在 → 409;**path 顶层目录** → 同事务 UPDATE tasks.working_dir + FOR UPDATE 锁;有 running/cancelling → 409;check_no_subtask 防嵌套 → 409 | 必填 |
|
|
| `GET /v1/tasks/{id}/export` | 对话导出 .docx | 必填 |
|
|
|
|
**SSE 事件**(每帧 `event: <type>` + `data: <JSON>`):`run_start{}` → `llm_start{}` → `text{delta}` / `tool_call{name,args,args_preview}` / `tool_result{name,preview,truncated}` → `llm_end{prompt_tokens,completion_tokens}` → `done{}`;cancel 走 `cancelled{}` 后随 `done{}` 收流;异常走 `error{msg}`。30s 无 event 服务端发 `: ping` 心跳。nginx 反代记得关 buffering(响应头已带 `X-Accel-Buffering: no` 默认起效)。
|
|
|
|
**SSE 客户端注意**:浏览器原生 `EventSource` 不支持自定义 header,无法塞 Bearer token。要么 `fetch + ReadableStream` 自解 SSE 帧(dev.html 走的就是这条),要么后端日后加 `?token=...` query(目前不支持,避免 token 进 access log)。
|
|
|
|
---
|
|
|
|
## 故障兜底
|
|
|
|
| 现象 | 原因 / 处理 |
|
|
|---|---|
|
|
| `ZCBOT_DB_URL is not set` | `.env` 没写 / litellm 链路没触发。直跑脚本时 `import litellm` 或 `export ZCBOT_DB_URL=...` |
|
|
| `ModuleNotFoundError: litellm` | 用了全局 `python`,改 `.venv/Scripts/python.exe ...` |
|
|
| Windows 控制台 emoji 崩 | Python stdout 是 GBK。用 `[OK]` / `[ng]` 等 ASCII 标签(见 memory) |
|
|
| `db upgrade` 报 `column already exists` | DB 已被改过,`db current` 确认 revision,必要时手 ALTER 或 `db downgrade base` 重来 |
|
|
| Resume 找不到 task | dev SPA 左侧 task 列表看 task_id 是否在;或 `curl /v1/tasks` 拉 |
|
|
| `--working-dir` 指定后 task 删了目录还在 | 设计如此 — 工作目录绝不 rmtree(同 working_dir 多 task 共享);DB 行该删还是删。要彻底删手动 `rm -rf <dir>` |
|
|
| Export 报 "无可导出内容" | task 没 messages(只 system 不算);先发条消息再 export |
|
|
| `NoSubtaskError: working_dir ... 前缀嵌套` | §7.4 no-subtask:同 user 不允许 working_dir 嵌套(child / parent)。**同项目多对话**用**完全相同**的 working_dir;否则改成 sibling(平级) |
|
|
| `main.py web` 启动后 curl 连不上 | 检查 proxy(`HTTP_PROXY` / `HTTPS_PROXY`):本地服务 127.0.0.1,系统 proxy 拦截会 502。临时 `unset HTTP_PROXY HTTPS_PROXY` 或 `curl --noproxy '*'`。验通:`curl --noproxy '*' http://127.0.0.1:8765/healthz` |
|
|
| SSE 卡住不流(经 nginx) | 反代要关 buffering — 后端响应头已带 `X-Accel-Buffering: no`(nginx ≥1.5.6 默认认)。仍卡看 nginx 配 `proxy_buffering off; proxy_read_timeout 3600s;` |
|
|
| platform CORS preflight 失败 | 本地 dev `allow_origins=["*"]` 应该没事;部署后看是否按 platform 域名收紧过头 |
|
|
| `POST /v1/tasks/{id}/messages` 返 409 `task already has an active run` | 上一条消息的 BG run 还没跑完;等流式 done 或点 stop / `POST .../cancel`;服务异常下 `run_status` 卡 `running`/`cancelling`,启动 reaper 会清 |
|
|
| `POST /v1/tasks/{id}/cancel` 返 409 `task not running` | `run_status` 不是 `running`(idle / cancelling / error 都不能 cancel);dev SPA 自动忽略不报错 |
|
|
| 点 stop 后流式没立刻停 | LLM 同步 call 不可中断,最坏等当前一轮跑完(几十秒);loop 进入下个 check 点(每轮 LLM 前 / 每个 tool_call 前)就退,emit `cancelled` → SSE `done` → UI 收回 stop |
|
|
| `[startup] reaped N stale active run(s)` | 上次 web 进程未正常 finish 留下 N 个孤儿 run,启动 lifespan 自动标 error。info 级,无需处理 |
|
|
| `POST /v1/files/delete` 返 409 `folder ... 仍被 N 个 task 引用` | 顶层目录被 task 引用 working_dir;先 `DELETE /v1/tasks/{id}` 删完关联 task 再删目录。子目录不受此限 |
|
|
| `POST /v1/files/rename` 返 409 `folder has active run(s)` | 顶层目录被某 running/cancelling 的 task 占用;先 cancel 等流式 done 再 rename |
|
|
| `POST /v1/files/rename` 返 409 `... 前缀嵌套` | 改名后会与其他 task 的 working_dir 形成嵌套;换不冲突的 new_name |
|
|
| 启动报 `PLATFORM_KEY env not set` / `JWT_SECRET env not set` | D' 过渡 auth 强制双 env 必填。生成 `python -c "import secrets;print(secrets.token_urlsafe(48))"` 各填一,写 `.env` 重起 |
|
|
| `/v1/auth/login_password` 返 403 `invalid email or password` | 邮箱不存在 / `password_hash` 列为空(platform_key 入口建的 user) / 密码错。`SELECT user_id, email, password_hash IS NOT NULL AS has_pw FROM users WHERE email=...` 核对;无行 → `main.py user add`;有行无密码 → `UPDATE users SET password_hash=...`(用 `.venv/Scripts/python.exe -c "from web.auth import hash_password;print(hash_password('xxx'))"` 算)或 `user add --user-id` 接到现有 user_id |
|
|
| `main.py user add` 报 `IntegrityError ... uq_users_email` | 邮箱已存在,改 email 或先 `DELETE FROM users WHERE email=...`(先清该 user 的 tasks) |
|
|
| `main.py user add` 报 `IntegrityError ... users_pkey` | `--user-id` 撞已有 UUID,换一个或不传让随机生成 |
|
|
| 改了用户邮箱 / 密码后他登不上 | `UPDATE users SET email=...` 不影响 user_id(行同一行,task 仍归属),用新邮箱登即可;DB 里应存小写(后端 lower() 后查)。改密 `UPDATE users SET password_hash=<bcrypt>` 同理 |
|
|
| `/v1/*` 全返 401 `missing Authorization: Bearer` | 没拿 token 或没带 header。先 login 拿 token,curl 加 `-H "Authorization: Bearer $TOKEN"` |
|
|
| `/v1/*` 返 401 `token expired` | JWT 默 7d TTL 到期,重 login。要更长改 `ZCBOT_JWT_TTL_SECONDS` env |
|
|
| dev.html SSE 收不到流(消息发出去 UI 没动) | EventSource 不支持 header,dev.html 走 `fetch + ReadableStream`。devtools Network 看 POST /messages 是否 202 + events_url GET 是否 200 + Content-Type 是 text/event-stream;401 → token 过期,logout 重 login |
|
|
| dev.html 显示 "load failed" 立刻回登录页 | token 过期或 JWT_SECRET 服务端变了。已自动跳登录页,按上次 tab 重登 |
|
|
|
|
---
|
|
|
|
## 关键路径与文件
|
|
|
|
- **入口**:`main.py`(`web / db / probe / user`)→ `core/agent_builder.py::build_agent`
|
|
- **核心**:`core/{agent_builder, loop, session, task, llm, memory, paths}.py` + `core/storage/{engine,models,utils}.py` + `db/migrations/`
|
|
- **工具**:`tools/{fs, shell, run_python, skill_tool}.py`
|
|
- **Web**:`web/{app.py, auth.py, broker.py, sinks.py}` + `web/static/dev.html`(dev SPA)+ `web/static/vendor/`(office 预览 jszip/docx-preview/xlsx)
|
|
- **配置**:`config/agent.yaml` + `config/models/*.yaml`(§3.2 Model Profile)
|
|
- **Skill**:`skills/{coding,ppt,proposal}/SKILL.md`(渐进披露,§3.5)
|
|
- **Workspace**(per-user 子树,user_id 来自 JWT `sub`):
|
|
- `workspace/users/<user_id>/.memory/{core.md, extended/}` — 跨 task 记忆,FS 永久,dotfile 隔离
|
|
- `workspace/users/<user_id>/<working_dir>/` — 工作目录,用户起名,同 working_dir 多 task 共享
|
|
|
|
---
|
|
|
|
## 维护约定
|
|
|
|
- **改对外行为(CLI 选项 / env / 文件布局)→ 同步本文档**。bug 修不动这个,只动 PROGRESS。
|
|
- 故障兜底新增:用过一次的真实坑,写一行,不预测。
|
|
- 跟 DESIGN/PROGRESS 边界:DESIGN 写"为什么",PROGRESS 写"做到哪",RUN 写"怎么跑"。
|