@saluzi/saluzi-edu 0.2.49 → 0.2.50
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli.js +40 -40
- package/dist/guide/guide-data.json +5 -1
- package/package.json +1 -1
|
@@ -1927,6 +1927,10 @@
|
|
|
1927
1927
|
"name": "SALUZI_BLOCKING_LIMIT_OVERRIDE",
|
|
1928
1928
|
"category": "other"
|
|
1929
1929
|
},
|
|
1930
|
+
{
|
|
1931
|
+
"name": "SALUZI_BRIDGE_ALLOW_INSECURE_HTTP",
|
|
1932
|
+
"category": "other"
|
|
1933
|
+
},
|
|
1930
1934
|
{
|
|
1931
1935
|
"name": "SALUZI_BRIDGE_BASE_URL",
|
|
1932
1936
|
"category": "bridge",
|
|
@@ -3226,7 +3230,7 @@
|
|
|
3226
3230
|
"可见域"
|
|
3227
3231
|
]
|
|
3228
3232
|
},
|
|
3229
|
-
"content": "\n## Remote Control Server (RCS)\n\nRCS 是 Saluzi 的自托管远程控制服务器,提供 Web UI 和会话管理。启动后,团队成员通过浏览器访问 Web UI,登录后即可创建会话、查看 worker 状态、与 agent 交互。\n\n## 启动 RCS\n\n```bash\n# 设置 API Key(管理员密码,也是 worker 连接 token)\nexport RCS_API_KEYS=sk-your-key\n\n# 启动(在 Saluzi CLI 中运行)\n> /rcs\n```\n\n也可通过 CLI 子命令直接启动:\n\n```bash\nslz rcs\n```\n\n默认端口 3000,Web UI 在 `http://localhost:3000/code/`。\n\n## RCS Web UI 使用\n\nWeb UI 是团队成员日常使用的控制面板:登录后可创建会话、查看 worker、审批权限、管理团队与环境。下面按首次部署到日常使用的顺序介绍。\n\n### 管理员初始化(首次访问)\n\n第一次打开 Web UI 时,系统没有任何用户。第一个登录的账号会成为系统管理员(role=admin),流程如下:\n\n1. 浏览器打开 `http://localhost:3000/code/`,自动跳转到 Setup 页面\n2. 填写表单:\n - **API Key**:必须与 RCS 启动时设置的 `RCS_API_KEYS` 中的某个 key 完全一致\n - **用户名**:登录用,后续不可改\n - **密码**:至少 8 位\n - **确认密码**\n3. 提交后第一个用户即成为 admin,进入管理面板\n\n后续访问的用户分两种:\n\n- **自注册**:如果 `RCS_ALLOW_REGISTRATION` 未设为 `false`(默认开放),新访问者可在登录页注册账户(用户名 + 密码)。密码以 argon2id 加密存储,登录有速率限制(5 次失败后锁定 5 分钟)。\n- **邀请制**:将 `RCS_ALLOW_REGISTRATION=false` 后,只有管理员预先创建的账户或通过团队邀请链接加入的用户能登录。\n\n管理员 API Key 拥有系统级权限,可直接访问所有 API(不通过 Web UI 登录流程)。\n\n登录后浏览器会保存 session cookie(`rcs_access`),后续请求自动认证。\n\n### 团队与角色\n\nRCS 用「团队」组织成员、环境和会话。每个登录用户都有一个「个人空间」(无需创建),可被加入一个或多个团队。\n\n**系统级角色**(`users.role`):\n\n| 角色 | 能力 |\n|------|------|\n| `admin` | 看到所有会话(含无主孤儿)、管理所有团队、转移任意环境;通常由 Setup 流程产生 |\n| 普通用户 | 仅看到自己拥有的、所属团队可见的、显式共享给自己的会话 |\n| `guest` | 不能创建团队;通常对应被降级的账户 |\n\n**团队级角色**(`team_members.role`):\n\n| 角色 | 团队内能力 |\n|------|-----------|\n| `owner` | 修改团队信息、删除团队、加/减成员、改成员角色、创建/撤销邀请、转移或解绑环境 |\n| `admin` | 加成员、创建/撤销邀请,但不能改 owner/admin 的角色,也不能删团队 |\n| `member` | 只能自退团队,看不到团队级管理按钮 |\n\n团队至少要保留一个 owner — 系统禁止降级或移除最后一个 owner。系统 admin 在任何团队中都视为 owner。\n\n**邀请加入**:团队 owner/admin 可在「团队详情 → 邀请」页面创建邀请链接,链接形如 `/join/<inv_xxx>`,可设置:\n\n- 角色:新成员加入后的角色(仅 `admin` 或 `member`,不能邀请为 owner)\n- 过期时间(默认 24 小时)\n- 最大使用次数(默认 1)\n\n也可以「添加已有用户」:通过用户名或用户 ID 搜索已注册账户,直接加入团队。\n\n### 环境管理\n\n「环境」(environment)是 worker 向 RCS 注册后产生的实体,代表一台正在提供 agent 服务的工作机。每个环境有:\n\n- 拥有者(owner_user_id,可能为空 → 需要认领)\n- 关联团队(可选,关联后团队内成员可见该环境及其会话)\n- worker 类型(slz CLI / ACP agent)、容量、心跳\n\n**环境的归属**:\n\n- 启动 worker 时通过 `--user-id` / `--team-id` 指定 → 直接归属到该用户或团队\n- 未指定且使用共享 API Key → 生成 `claim_token`,进入待认领状态(见下文 claim 机制)\n\n**环境与团队的关联**:\n\n- 在「团队详情 → 环境」页面可把个人环境链接到团队,或把团队环境解绑回个人\n- 环境可在团队之间转移(需要源团队和目标团队的 owner/admin 权限)\n- 转移环境时,该环境下的所有会话归属随之转移到目标团队\n\n### Claim 机制(环境认领)\n\n当 worker 使用共享 API Key 启动、且未指定 `--user-id` / `--team-id` 时,RCS 不会把环境直接归属给任何人,而是生成一个 `claim_token`(形如 `clm_xxxxxxxx`)并打印认领 URL:\n\n```\n/code/claim/clm_xxxxxxxx\n```\n\n**认领流程**:\n\n1. worker 启动后在终端看到认领 URL\n2. 把这个 URL 发给任意已登录用户\n3. 该用户在浏览器打开 URL → 自动调用 `/environments/claim` 接口\n4. 该环境的 `owner_user_id` 写入此用户,`claim_token` 清空\n5. 该环境下已经创建的会话也会一并 backfill 到该用户名下(否则会成为无主孤儿会话)\n\n`claim_token` 有过期时间(`claim_expires_at`),过期后无法认领。已被认领的环境再次访问会返回 409。\n\n这个机制让团队成员用共享 API Key 启动 worker 后,再由具体的人认领,避免环境长期处于无主状态。\n\n### 会话可见域\n\n每个会话有 `visibility` 字段,控制谁能看到它:\n\n| 可见域 | 谁能看到 |\n|--------|---------|\n| `private` | 仅会话的 user owner |\n| `team` | 会话所属团队的所有成员 |\n| `public` | 所有登录用户 |\n\n实际的可见规则综合考虑了 ownership、visibility 和显式共享:\n\n1. 系统 admin 能看到所有会话(含无主孤儿会话)\n2. 用户作为 user owner 拥有的会话\n3. 用户所属团队作为 team owner 拥有、且 visibility 为 `team` 或 `public` 的会话\n4. 通过 `session_shares` 显式共享给该用户的会话(未过期)\n5. 通过 `session_shares` 显式共享给该用户所属团队的会话(未过期)\n6. visibility=`public` 的会话\n7. 无主孤儿会话:仅 admin 可见\n\n**会话转移**:会话 owner(或团队 admin)可把会话从个人空间转到团队(visibility 自动变 `team`),或从团队转回个人(visibility 自动变 `private`)。转移时需要目标是该团队的 owner/admin。\n\n**会话分享**:会话 owner 可生成分享链接,授予指定用户或团队「只读」或「读写」权限,可设置过期时间。被分享者会在自己的会话列表里看到该会话。\n\n### 权限审批\n\nRCS Web UI 在 agent 请求工具调用时弹出审批面板。权限模式(permissionMode)有 6 种,决定 agent 是否需要等待人工确认:\n\n| 模式 | 行为 |\n|------|------|\n| `default` | 每次工具调用都请求确认 |\n| `auto` | agent 自动判断是否需要确认 |\n| `acceptEdits` | 自动接受文件编辑,其他工具仍需确认 |\n| `plan` | 规划模式,仅制定计划不执行 |\n| `dontAsk` | 不询问,直接执行 |\n| `bypassPermissions` | 绕过所有权限检查(仅 sandbox 环境可用,非 root) |\n\n权限模式可在创建会话时指定,也可在会话进行中切换。fallback 顺序:客户端传值 > acp-link 启动时的 `ACP_PERMISSION_MODE` 环境变量。\n\n**三种审批面板**:\n\n- **工具调用审批**:显示工具名、参数和描述,提供 Approve / Reject 按钮\n- **多问题面板**(AskUserQuestion):agent 一次提多个问题,用户在标签页中切换回答,每题可选预设选项或填写「Other」自定义文本\n- **计划审批**:显示 plan 内容,提供「Yes, auto-accept edits」「Yes, manually approve edits」「No, keep planning」三个选项,选 No 时可附反馈让 agent 重新规划\n\n### Worker 状态\n\nWeb UI 显示所有已连接的 worker(包括 slz CLI worker 和 acp-link agent):\n\n- **在线状态**:worker 当前是否可接受会话\n- **最大并发**:worker 配置的 `--capacity`\n- **最后活动时间**:最近一次心跳\n\n## RCS 服务器配置\n\n| 环境变量 | 默认 | 说明 |\n|---------|------|------|\n| `RCS_PORT` | 3000 | HTTP 端口 |\n| `RCS_HOST` | 0.0.0.0 | 监听地址 |\n| `RCS_API_KEYS` | — | 逗号分隔的 API Key(管理员权限,也是 worker 连接 token) |\n| `RCS_ALLOW_REGISTRATION` | true | 是否允许开放注册(设为 false 改为邀请制) |\n| `RCS_BASE_URL` | — | 外部访问 URL(反代时设置) |\n| `RCS_DB_PATH` | — | SQLite 数据库路径(默认内存,生产环境建议持久化) |\n| `RCS_WEB_CORS_ORIGINS` | — | Web UI CORS 允许的源(逗号分隔) |\n| `RCS_JWT_EXPIRES_IN` | 3600 | JWT 有效期(秒) |\n| `RCS_DISCONNECT_TIMEOUT` | 300 | 断开连接超时(秒) |\n| `RCS_WS_CLIENT_INACTIVITY_TIMEOUT` | 300 | WebSocket 客户端无活动超时(秒) |\n\n## Worker 接入\n\nWorker 是连接到 RCS 的 Saluzi CLI 实例,执行来自 Web UI 或其他客户端的会话。\n\n### 前置:设置环境变量\n\n**所有 worker 启动方式都需要先设置以下两个环境变量**:\n\n```bash\nexport SALUZI_BRIDGE_BASE_URL=http://rcs-host:3000\nexport SALUZI_BRIDGE_OAUTH_TOKEN=sk-your-key\n```\n\n- `SALUZI_BRIDGE_BASE_URL`:RCS 服务器地址\n- `SALUZI_BRIDGE_OAUTH_TOKEN`:必须与 RCS 启动时设置的 `RCS_API_KEYS` 中的某个 key 一致\n\n两个变量必须**同时设置**才生效。只设置一个会进入\"部分配置\"状态,启动时会提示补全。\n\n可选环境变量(用于归属和团队关联):\n\n| 环境变量 | 说明 |\n|---------|------|\n| `SALUZI_BRIDGE_USERNAME` | 归属用户名(发送为 `X-Username` 头,RCS 自动认领 env 到该用户) |\n| `SALUZI_BRIDGE_USER_ID` | 归属用户 ID(绕过自动认领,直接绑定到该用户) |\n| `SALUZI_BRIDGE_TEAM_ID` | 关联团队 ID(env 注册到指定团队) |\n| `SALUZI_ENVIRONMENT_KIND` | 设为 `bridge` 标记会话来源为 remote-control |\n| `SALUZI_USE_CCR_V2` | 启用 CCR v2 传输协议 |\n\n如果不设置 `SALUZI_BRIDGE_USERNAME`/`SALUZI_BRIDGE_USER_ID`/`SALUZI_BRIDGE_TEAM_ID`,且 token 是共享的管理员 API Key,RCS 会生成 `claim_token` 并打印认领 URL,worker 终端会显示该 URL 供用户认领(详见上文「Claim 机制」)。\n\n### 启动方式\n\n设置好环境变量后,推荐直接运行:\n\n```bash\nslz rc\n```\n\n`slz rc` 是最简的启动方式,默认配置即可作为 worker 连接到 RCS。它是 `slz remote-control` 的简写,也接受 `slz remote`、`slz sync`、`slz bridge` 作为别名。\n\n其他可选方式:\n\n```bash\n# 交互式会话 + worker(既可本地用,也接受远程请求)\nslz --remote-control\n\n# 普通会话自动连接(设置好环境变量后直接运行)\nslz\n```\n\n### 高级参数\n\n需要调整 worker 行为时,`slz rc` 支持以下参数:\n\n| 参数 | 说明 | 示例 |\n|------|------|------|\n| `--spawn <mode>` | Spawn 模式:`same-dir`、`worktree`、`session` | `--spawn=worktree` |\n| `--capacity <N>` | 最大并发会话数(仅 worktree/session 模式) | `--capacity=5` |\n| `--create-session-in-dir` | 启动时在当前目录预创建会话(默认开启) | `--no-create-session-in-dir` 禁用 |\n| `--session-id <id>` | 恢复指定会话 | `--session-id=abc123` |\n| `--continue` | 恢复最近会话 | — |\n| `--name <name>` | 会话名称(也用于 RCS 显示) | `--name=\"我的会话\"` |\n| `--username <name>` | 归属用户名(对应 `SALUZI_BRIDGE_USERNAME`) | `--username=alice` |\n| `--user-id <id>` | 归属用户 ID(对应 `SALUZI_BRIDGE_USER_ID`) | `--user-id=u-123` |\n| `--team-id <id>` | 关联团队 ID(对应 `SALUZI_BRIDGE_TEAM_ID`) | `--team-id=team-abc` |\n\n### Spawn 模式\n\n| 模式 | 说明 | 适用场景 |\n|------|------|---------|\n| `same-dir`(默认) | 所有会话在同一工作目录创建 | 单项目快速响应 |\n| `worktree` | 每个会话在独立 git worktree 中创建 | 多项目隔离,避免文件冲突 |\n| `session` | 单会话模式(容量固定为 1) | 简单场景,不需要并发 |\n\n## Worker 与 RCS 的关系\n\n```\n┌─────────────────┐\n│ RCS Server │ ← 运行 slz rcs\n│ (Web UI + API) │\n└────────┬────────┘\n │ Bridge 协议\n │\n ┌────┴────┐\n │ │\n┌───▼──┐ ┌──▼───┐\n│Worker│ │Worker│ ← slz rc / slz --remote-control / slz\n│ 1 │ │ 2 │\n└──────┘ └──────┘\n```\n\n- **RCS**:中央服务器,管理会话、用户、权限\n- **Worker**:通过 bridge 协议连接,从 RCS 获取任务,汇报状态\n- **Web UI**:通过浏览器访问 RCS,创建/查看会话\n\n## ACP 协议\n\nACP(Agent Control Protocol)让**外部 agent**(非 slz CLI,如 Claude Code、其他 ACP 兼容 agent)接入 RCS 的会话系统。slz CLI 自身使用 bridge 协议,不走 ACP。\n\n`acp-link` 是 ACP 桥接工具,随 `@saluzi/saluzi-edu` 一起安装,无需单独安装。\n\n### 连接 slz 到 RCS\n\n如果要让 slz CLI 作为 ACP agent 接入 RCS(而非 bridge worker),使用 `acp-link` 桥接:\n\n#### 1. 设置环境变量\n\n```bash\nexport ACP_RCS_URL=http://rcs-host:3000\nexport ACP_RCS_TOKEN=sk-your-key\n```\n\n- `ACP_RCS_URL`:RCS 服务器地址\n- `ACP_RCS_TOKEN`:必须与 RCS 的 `RCS_API_KEYS` 中的某个 key 一致\n\n可选环境变量:\n\n| 环境变量 | 说明 |\n|---------|------|\n| `ACP_RCS_GROUP` | Channel group ID(字母、数字、下划线、连字符) |\n| `ACP_RCS_USERNAME` | 归属用户名(自动认领 env 到该用户) |\n| `ACP_RCS_USER_ID` | 归属用户 ID(绕过自动认领) |\n| `ACP_RCS_TEAM_ID` | 关联团队 ID |\n| `ACP_AUTH_TOKEN` | 本地 WS 认证 token(不设则自动生成) |\n| `ACP_PERMISSION_MODE` | 默认权限模式 |\n\n#### 2. 启动 acp-link\n\n```bash\nacp-link slz -- --acp\n```\n\n`acp-link` 会启动 slz 作为子进程,通过 ACP 协议代理它与 RCS 之间的通信。slz 会出现在 RCS Web UI 的 agent 列表中,可接受会话请求。\n\n`--` 之后是传递给 slz 的参数(`--acp` 让 slz 进入 ACP 兼容模式)。\n\n### 连接 Claude Code 到 RCS\n\n`acp-link` 支持任何遵循 ACP 协议的 agent。Claude Code 通过专用的 ACP 适配包 `@agentclientprotocol/claude-agent-acp` 接入,接入命令是 `acp-link claude-agent-acp`(**不是** `acp-link claude`,因为 Claude Code 本身不直接说 ACP 协议,需要先装适配包)。\n\n#### 1. 安装 claude-agent-acp\n\nClaude Code 的 ACP 适配包需要单独安装:\n\n```bash\nnpm install -g @agentclientprotocol/claude-agent-acp\n```\n\n安装后会注册 `claude-agent-acp` 命令。\n\n#### 2. 设置环境变量\n\n```bash\nexport ACP_RCS_URL=http://rcs-host:3000\nexport ACP_RCS_TOKEN=sk-your-key\n```\n\n#### 3. 启动 acp-link 桥接\n\n```bash\nacp-link claude-agent-acp\n```\n\n`acp-link` 的第一个参数是 agent 的可执行命令名(这里是 `claude-agent-acp`)。`claude-agent-acp` 本身不需要额外参数,因此不需要 `--`。\n\n连接成功后,Claude Code 会作为 ACP agent 出现在 RCS Web UI 中,与 slz agent 并列,团队成员可在 Web UI 中选择它创建会话。\n\n其他 ACP 兼容 agent 的接入方式类似:安装对应的 ACP 适配包,然后用 `acp-link <命令名>` 启动。可在 npm 官网搜索 `@agentclientprotocol/*` 查找已适配的 agent。\n\n## 团队协作场景\n\n### 共享会话\n\n在 RCS Web UI 中创建会话,分享链接给队友(需登录才能查看),他们可查看或加入对话。也可通过 `session_shares` 显式授予指定用户或团队「只读」/「读写」权限,并设置过期时间。\n\n### 多 Worker 协作\n\n团队多个成员各自启动 worker,连接到同一 RCS:\n\n```bash\n# 成员 A:默认配置\nslz rc\n\n# 成员 B:worktree 隔离,5 并发\nslz rc --spawn=worktree --capacity=5\n```\n\nWeb UI 显示所有 worker 状态,会话与权限集中管理。\n\n### 外部 Agent 接入\n\n用 ACP 让非 slz 的 agent 接入 RCS。Claude Code 通过 `claude-agent-acp` 适配包接入:\n\n```bash\n# 先装适配包(仅一次)\nnpm install -g @agentclientprotocol/claude-agent-acp\n\n# 设置 RCS 连接\nexport ACP_RCS_URL=http://rcs-host:3000\nexport ACP_RCS_TOKEN=sk-your-key\n\n# 启动桥接\nacp-link claude-agent-acp\n```\n\n接入后所有 agent 在 Web UI 中统一管理,团队成员可选择任意 agent 创建会话。\n\n## 安全建议\n\n- RCS 默认监听 0.0.0.0,生产环境建议用反代 + HTTPS\n- 用强 API Key,定期轮换\n- 生产环境关闭 `RCS_ALLOW_REGISTRATION` 改为邀请制\n- 使用 `RCS_WEB_CORS_ORIGINS` 限制 Web UI 访问来源\n- 设置 `RCS_DB_PATH` 持久化 SQLite 数据库\n- 限制 worker 的权限(`/permissions` 配置)\n- `bypassPermissions` 模式仅在 sandbox 环境中启用,避免在主机直接放行所有工具调用\n\n## 故障排查\n\n| 问题 | 排查 |\n|------|------|\n| Worker 无法连接 | 检查 `SALUZI_BRIDGE_BASE_URL` 和 `SALUZI_BRIDGE_OAUTH_TOKEN` 是否同时设置;确认 token 与 RCS 的 `RCS_API_KEYS` 匹配 |\n| Web UI 登录失败 | 检查用户名密码;5 次失败后锁定 5 分钟 |\n| Web UI 401 | 确认使用 `RCS_API_KEYS` 中的 key 或有效的 session token |\n| 看不到某个会话 | 检查会话 visibility(private/team/public);确认是否在所属团队的成员列表里;admin 可看所有 |\n| 环境显示「待认领」 | worker 没指定 `--user-id`/`--team-id`,找到终端里的 `/code/claim/clm_xxx` URL,已登录用户打开即可认领 |\n| acp-link 无法连接 RCS | 检查 `ACP_RCS_URL` 和 `ACP_RCS_TOKEN` 是否设置 |\n| Agent 不出现在 Web UI | 确认 acp-link 已启动且 `ACP_RCS_TOKEN` 与 `RCS_API_KEYS` 匹配 |\n| 邀请链接失效 | 邀请 token 可能过期或达到 max_uses 上限;让团队 owner/admin 重新创建 |\n| 会话超时 | 调整 `RCS_DISCONNECT_TIMEOUT` 和 `RCS_WS_CLIENT_INACTIVITY_TIMEOUT` |\n"
|
|
3233
|
+
"content": "\n## Remote Control Server (RCS)\n\nRCS 是 Saluzi 的自托管远程控制服务器,提供 Web UI 和会话管理。启动后,团队成员通过浏览器访问 Web UI,登录后即可创建会话、查看 worker 状态、与 agent 交互。\n\n## 启动 RCS\n\n```bash\n# 设置 API Key(管理员密码,也是 worker 连接 token)\nexport RCS_API_KEYS=sk-your-key\n\n# 启动(在 Saluzi CLI 中运行)\n> /rcs\n```\n\n也可通过 CLI 子命令直接启动:\n\n```bash\nslz rcs\n```\n\n默认端口 3000,Web UI 在 `http://localhost:3000/code/`。\n\n## RCS Web UI 使用\n\nWeb UI 是团队成员日常使用的控制面板:登录后可创建会话、查看 worker、审批权限、管理团队与环境。下面按首次部署到日常使用的顺序介绍。\n\n### 管理员初始化(首次访问)\n\n第一次打开 Web UI 时,系统没有任何用户。第一个登录的账号会成为系统管理员(role=admin),流程如下:\n\n1. 浏览器打开 `http://localhost:3000/code/`,自动跳转到 Setup 页面\n2. 填写表单:\n - **API Key**:必须与 RCS 启动时设置的 `RCS_API_KEYS` 中的某个 key 完全一致\n - **用户名**:登录用,后续不可改\n - **密码**:至少 8 位\n - **确认密码**\n3. 提交后第一个用户即成为 admin,进入管理面板\n\n后续访问的用户分两种:\n\n- **自注册**:如果 `RCS_ALLOW_REGISTRATION` 未设为 `false`(默认开放),新访问者可在登录页注册账户(用户名 + 密码)。密码以 argon2id 加密存储,登录有速率限制(5 次失败后锁定 5 分钟)。\n- **邀请制**:将 `RCS_ALLOW_REGISTRATION=false` 后,只有管理员预先创建的账户或通过团队邀请链接加入的用户能登录。\n\n管理员 API Key 拥有系统级权限,可直接访问所有 API(不通过 Web UI 登录流程)。\n\n登录后浏览器会保存 session cookie(`rcs_access`),后续请求自动认证。\n\n### 团队与角色\n\nRCS 用「团队」组织成员、环境和会话。每个登录用户都有一个「个人空间」(无需创建),可被加入一个或多个团队。\n\n**系统级角色**(`users.role`):\n\n| 角色 | 能力 |\n|------|------|\n| `admin` | 看到所有会话(含无主孤儿)、管理所有团队、转移任意环境;通常由 Setup 流程产生 |\n| 普通用户 | 仅看到自己拥有的、所属团队可见的、显式共享给自己的会话 |\n| `guest` | 不能创建团队;通常对应被降级的账户 |\n\n**团队级角色**(`team_members.role`):\n\n| 角色 | 团队内能力 |\n|------|-----------|\n| `owner` | 修改团队信息、删除团队、加/减成员、改成员角色、创建/撤销邀请、转移或解绑环境 |\n| `admin` | 加成员、创建/撤销邀请,但不能改 owner/admin 的角色,也不能删团队 |\n| `member` | 只能自退团队,看不到团队级管理按钮 |\n\n团队至少要保留一个 owner — 系统禁止降级或移除最后一个 owner。系统 admin 在任何团队中都视为 owner。\n\n**邀请加入**:团队 owner/admin 可在「团队详情 → 邀请」页面创建邀请链接,链接形如 `/join/<inv_xxx>`,可设置:\n\n- 角色:新成员加入后的角色(仅 `admin` 或 `member`,不能邀请为 owner)\n- 过期时间(默认 24 小时)\n- 最大使用次数(默认 1)\n\n也可以「添加已有用户」:通过用户名或用户 ID 搜索已注册账户,直接加入团队。\n\n### 环境管理\n\n「环境」(environment)是 worker 向 RCS 注册后产生的实体,代表一台正在提供 agent 服务的工作机。每个环境有:\n\n- 拥有者(owner_user_id,可能为空 → 需要认领)\n- 关联团队(可选,关联后团队内成员可见该环境及其会话)\n- worker 类型(slz CLI / ACP agent)、容量、心跳\n\n**环境的归属**:\n\n- 启动 worker 时通过 `--user-id` / `--team-id` 指定 → 直接归属到该用户或团队\n- 未指定且使用共享 API Key → 生成 `claim_token`,进入待认领状态(见下文 claim 机制)\n\n**环境与团队的关联**:\n\n- 在「团队详情 → 环境」页面可把个人环境链接到团队,或把团队环境解绑回个人\n- 环境可在团队之间转移(需要源团队和目标团队的 owner/admin 权限)\n- 转移环境时,该环境下的所有会话归属随之转移到目标团队\n\n### Claim 机制(环境认领)\n\n当 worker 使用共享 API Key 启动、且未指定 `--user-id` / `--team-id` 时,RCS 不会把环境直接归属给任何人,而是生成一个 `claim_token`(形如 `clm_xxxxxxxx`)并打印认领 URL:\n\n```\n/code/claim/clm_xxxxxxxx\n```\n\n**认领流程**:\n\n1. worker 启动后在终端看到认领 URL\n2. 把这个 URL 发给任意已登录用户\n3. 该用户在浏览器打开 URL → 自动调用 `/environments/claim` 接口\n4. 该环境的 `owner_user_id` 写入此用户,`claim_token` 清空\n5. 该环境下已经创建的会话也会一并 backfill 到该用户名下(否则会成为无主孤儿会话)\n\n`claim_token` 有过期时间(`claim_expires_at`),过期后无法认领。已被认领的环境再次访问会返回 409。\n\n这个机制让团队成员用共享 API Key 启动 worker 后,再由具体的人认领,避免环境长期处于无主状态。\n\n### 会话可见域\n\n每个会话有 `visibility` 字段,控制谁能看到它:\n\n| 可见域 | 谁能看到 |\n|--------|---------|\n| `private` | 仅会话的 user owner |\n| `team` | 会话所属团队的所有成员 |\n| `public` | 所有登录用户 |\n\n实际的可见规则综合考虑了 ownership、visibility 和显式共享:\n\n1. 系统 admin 能看到所有会话(含无主孤儿会话)\n2. 用户作为 user owner 拥有的会话\n3. 用户所属团队作为 team owner 拥有、且 visibility 为 `team` 或 `public` 的会话\n4. 通过 `session_shares` 显式共享给该用户的会话(未过期)\n5. 通过 `session_shares` 显式共享给该用户所属团队的会话(未过期)\n6. visibility=`public` 的会话\n7. 无主孤儿会话:仅 admin 可见\n\n**会话转移**:会话 owner(或团队 admin)可把会话从个人空间转到团队(visibility 自动变 `team`),或从团队转回个人(visibility 自动变 `private`)。转移时需要目标是该团队的 owner/admin。\n\n**会话分享**:会话 owner 可生成分享链接,授予指定用户或团队「只读」或「读写」权限,可设置过期时间。被分享者会在自己的会话列表里看到该会话。\n\n### 权限审批\n\nRCS Web UI 在 agent 请求工具调用时弹出审批面板。权限模式(permissionMode)有 6 种,决定 agent 是否需要等待人工确认:\n\n| 模式 | 行为 |\n|------|------|\n| `default` | 每次工具调用都请求确认 |\n| `auto` | agent 自动判断是否需要确认 |\n| `acceptEdits` | 自动接受文件编辑,其他工具仍需确认 |\n| `plan` | 规划模式,仅制定计划不执行 |\n| `dontAsk` | 不询问,直接执行 |\n| `bypassPermissions` | 绕过所有权限检查(仅 sandbox 环境可用,非 root) |\n\n权限模式可在创建会话时指定,也可在会话进行中切换。fallback 顺序:客户端传值 > acp-link 启动时的 `ACP_PERMISSION_MODE` 环境变量。\n\n**三种审批面板**:\n\n- **工具调用审批**:显示工具名、参数和描述,提供 Approve / Reject 按钮\n- **多问题面板**(AskUserQuestion):agent 一次提多个问题,用户在标签页中切换回答,每题可选预设选项或填写「Other」自定义文本\n- **计划审批**:显示 plan 内容,提供「Yes, auto-accept edits」「Yes, manually approve edits」「No, keep planning」三个选项,选 No 时可附反馈让 agent 重新规划\n\n### Worker 状态\n\nWeb UI 显示所有已连接的 worker(包括 slz CLI worker 和 acp-link agent):\n\n- **在线状态**:worker 当前是否可接受会话\n- **最大并发**:worker 配置的 `--capacity`\n- **最后活动时间**:最近一次心跳\n\n## RCS 服务器配置\n\n| 环境变量 | 默认 | 说明 |\n|---------|------|------|\n| `RCS_PORT` | 3000 | HTTP 端口 |\n| `RCS_HOST` | 0.0.0.0 | 监听地址 |\n| `RCS_API_KEYS` | — | 逗号分隔的 API Key(管理员权限,也是 worker 连接 token) |\n| `RCS_ALLOW_REGISTRATION` | true | 是否允许开放注册(设为 false 改为邀请制) |\n| `RCS_BASE_URL` | — | 外部访问 URL(反代时设置) |\n| `RCS_DB_PATH` | — | SQLite 数据库路径(默认内存,生产环境建议持久化) |\n| `RCS_WEB_CORS_ORIGINS` | — | Web UI CORS 允许的源(逗号分隔) |\n| `RCS_JWT_EXPIRES_IN` | 3600 | JWT 有效期(秒) |\n| `RCS_DISCONNECT_TIMEOUT` | 300 | 断开连接超时(秒) |\n| `RCS_WS_CLIENT_INACTIVITY_TIMEOUT` | 300 | WebSocket 客户端无活动超时(秒) |\n\n## Worker 接入\n\nWorker 是连接到 RCS 的 Saluzi CLI 实例,执行来自 Web UI 或其他客户端的会话。\n\n### 前置:设置环境变量\n\n**所有 worker 启动方式都需要先设置以下两个环境变量**:\n\n```bash\nexport SALUZI_BRIDGE_BASE_URL=http://rcs-host:3000\nexport SALUZI_BRIDGE_OAUTH_TOKEN=sk-your-key\n```\n\n- `SALUZI_BRIDGE_BASE_URL`:RCS 服务器地址\n- `SALUZI_BRIDGE_OAUTH_TOKEN`:必须与 RCS 启动时设置的 `RCS_API_KEYS` 中的某个 key 一致\n\n两个变量必须**同时设置**才生效。只设置一个会进入\"部分配置\"状态,启动时会提示补全。\n\n可选环境变量(用于归属和团队关联):\n\n| 环境变量 | 说明 |\n|---------|------|\n| `SALUZI_BRIDGE_USERNAME` | 归属用户名(发送为 `X-Username` 头,RCS 自动认领 env 到该用户) |\n| `SALUZI_BRIDGE_USER_ID` | 归属用户 ID(绕过自动认领,直接绑定到该用户) |\n| `SALUZI_BRIDGE_TEAM_ID` | 关联团队 ID(env 注册到指定团队) |\n| `SALUZI_ENVIRONMENT_KIND` | 设为 `bridge` 标记会话来源为 remote-control |\n| `SALUZI_USE_CCR_V2` | 启用 CCR v2 传输协议 |\n| `SALUZI_BRIDGE_ALLOW_INSECURE_HTTP` | 设为 `1` 允许非 localhost 的 HTTP 连接(自托管内网场景,见下文) |\n\n**关于 HTTP 连接**:默认情况下,`SALUZI_BRIDGE_BASE_URL` 如果是 `http://` 且不是 `localhost`/`127.0.0.1`,worker 会拒绝启动——这是为了防止 credentials 明文传输。如果远程 RCS 部署在可信内网(例如 TLS 由上游反代终止、或网络已加密),可设置 `SALUZI_BRIDGE_ALLOW_INSECURE_HTTP=1` 放开此限制。生产环境建议优先用 HTTPS 或 SSH 隧道转发到 localhost。\n\n如果不设置 `SALUZI_BRIDGE_USERNAME`/`SALUZI_BRIDGE_USER_ID`/`SALUZI_BRIDGE_TEAM_ID`,且 token 是共享的管理员 API Key,RCS 会生成 `claim_token` 并打印认领 URL,worker 终端会显示该 URL 供用户认领(详见上文「Claim 机制」)。\n\n### 启动方式\n\n设置好环境变量后,推荐直接运行:\n\n```bash\nslz rc\n```\n\n`slz rc` 是最简的启动方式,默认配置即可作为 worker 连接到 RCS。它是 `slz remote-control` 的简写,也接受 `slz remote`、`slz sync`、`slz bridge` 作为别名。\n\n其他可选方式:\n\n```bash\n# 交互式会话 + worker(既可本地用,也接受远程请求)\nslz --remote-control\n\n# 普通会话自动连接(设置好环境变量后直接运行)\nslz\n```\n\n### 高级参数\n\n需要调整 worker 行为时,`slz rc` 支持以下参数:\n\n| 参数 | 说明 | 示例 |\n|------|------|------|\n| `--spawn <mode>` | Spawn 模式:`same-dir`、`worktree`、`session` | `--spawn=worktree` |\n| `--capacity <N>` | 最大并发会话数(仅 worktree/session 模式) | `--capacity=5` |\n| `--create-session-in-dir` | 启动时在当前目录预创建会话(默认开启) | `--no-create-session-in-dir` 禁用 |\n| `--session-id <id>` | 恢复指定会话 | `--session-id=abc123` |\n| `--continue` | 恢复最近会话 | — |\n| `--name <name>` | 会话名称(也用于 RCS 显示) | `--name=\"我的会话\"` |\n| `--username <name>` | 归属用户名(对应 `SALUZI_BRIDGE_USERNAME`) | `--username=alice` |\n| `--user-id <id>` | 归属用户 ID(对应 `SALUZI_BRIDGE_USER_ID`) | `--user-id=u-123` |\n| `--team-id <id>` | 关联团队 ID(对应 `SALUZI_BRIDGE_TEAM_ID`) | `--team-id=team-abc` |\n\n### Spawn 模式\n\n| 模式 | 说明 | 适用场景 |\n|------|------|---------|\n| `same-dir`(默认) | 所有会话在同一工作目录创建 | 单项目快速响应 |\n| `worktree` | 每个会话在独立 git worktree 中创建 | 多项目隔离,避免文件冲突 |\n| `session` | 单会话模式(容量固定为 1) | 简单场景,不需要并发 |\n\n## Worker 与 RCS 的关系\n\n```\n┌─────────────────┐\n│ RCS Server │ ← 运行 slz rcs\n│ (Web UI + API) │\n└────────┬────────┘\n │ Bridge 协议\n │\n ┌────┴────┐\n │ │\n┌───▼──┐ ┌──▼───┐\n│Worker│ │Worker│ ← slz rc / slz --remote-control / slz\n│ 1 │ │ 2 │\n└──────┘ └──────┘\n```\n\n- **RCS**:中央服务器,管理会话、用户、权限\n- **Worker**:通过 bridge 协议连接,从 RCS 获取任务,汇报状态\n- **Web UI**:通过浏览器访问 RCS,创建/查看会话\n\n## ACP 协议\n\nACP(Agent Control Protocol)让**外部 agent**(非 slz CLI,如 Claude Code、其他 ACP 兼容 agent)接入 RCS 的会话系统。slz CLI 自身使用 bridge 协议,不走 ACP。\n\n`acp-link` 是 ACP 桥接工具,随 `@saluzi/saluzi-edu` 一起安装,无需单独安装。\n\n### 连接 slz 到 RCS\n\n如果要让 slz CLI 作为 ACP agent 接入 RCS(而非 bridge worker),使用 `acp-link` 桥接:\n\n#### 1. 设置环境变量\n\n```bash\nexport ACP_RCS_URL=http://rcs-host:3000\nexport ACP_RCS_TOKEN=sk-your-key\n```\n\n- `ACP_RCS_URL`:RCS 服务器地址\n- `ACP_RCS_TOKEN`:必须与 RCS 的 `RCS_API_KEYS` 中的某个 key 一致\n\n可选环境变量:\n\n| 环境变量 | 说明 |\n|---------|------|\n| `ACP_RCS_GROUP` | Channel group ID(字母、数字、下划线、连字符) |\n| `ACP_RCS_USERNAME` | 归属用户名(自动认领 env 到该用户) |\n| `ACP_RCS_USER_ID` | 归属用户 ID(绕过自动认领) |\n| `ACP_RCS_TEAM_ID` | 关联团队 ID |\n| `ACP_AUTH_TOKEN` | 本地 WS 认证 token(不设则自动生成) |\n| `ACP_PERMISSION_MODE` | 默认权限模式 |\n\n#### 2. 启动 acp-link\n\n```bash\nacp-link slz -- --acp\n```\n\n`acp-link` 会启动 slz 作为子进程,通过 ACP 协议代理它与 RCS 之间的通信。slz 会出现在 RCS Web UI 的 agent 列表中,可接受会话请求。\n\n`--` 之后是传递给 slz 的参数(`--acp` 让 slz 进入 ACP 兼容模式)。\n\n### 连接 Claude Code 到 RCS\n\n`acp-link` 支持任何遵循 ACP 协议的 agent。Claude Code 通过专用的 ACP 适配包 `@agentclientprotocol/claude-agent-acp` 接入,接入命令是 `acp-link claude-agent-acp`(**不是** `acp-link claude`,因为 Claude Code 本身不直接说 ACP 协议,需要先装适配包)。\n\n#### 1. 安装 claude-agent-acp\n\nClaude Code 的 ACP 适配包需要单独安装:\n\n```bash\nnpm install -g @agentclientprotocol/claude-agent-acp\n```\n\n安装后会注册 `claude-agent-acp` 命令。\n\n#### 2. 设置环境变量\n\n```bash\nexport ACP_RCS_URL=http://rcs-host:3000\nexport ACP_RCS_TOKEN=sk-your-key\n```\n\n#### 3. 启动 acp-link 桥接\n\n```bash\nacp-link claude-agent-acp\n```\n\n`acp-link` 的第一个参数是 agent 的可执行命令名(这里是 `claude-agent-acp`)。`claude-agent-acp` 本身不需要额外参数,因此不需要 `--`。\n\n连接成功后,Claude Code 会作为 ACP agent 出现在 RCS Web UI 中,与 slz agent 并列,团队成员可在 Web UI 中选择它创建会话。\n\n其他 ACP 兼容 agent 的接入方式类似:安装对应的 ACP 适配包,然后用 `acp-link <命令名>` 启动。可在 npm 官网搜索 `@agentclientprotocol/*` 查找已适配的 agent。\n\n## 团队协作场景\n\n### 共享会话\n\n在 RCS Web UI 中创建会话,分享链接给队友(需登录才能查看),他们可查看或加入对话。也可通过 `session_shares` 显式授予指定用户或团队「只读」/「读写」权限,并设置过期时间。\n\n### 多 Worker 协作\n\n团队多个成员各自启动 worker,连接到同一 RCS:\n\n```bash\n# 成员 A:默认配置\nslz rc\n\n# 成员 B:worktree 隔离,5 并发\nslz rc --spawn=worktree --capacity=5\n```\n\nWeb UI 显示所有 worker 状态,会话与权限集中管理。\n\n### 外部 Agent 接入\n\n用 ACP 让非 slz 的 agent 接入 RCS。Claude Code 通过 `claude-agent-acp` 适配包接入:\n\n```bash\n# 先装适配包(仅一次)\nnpm install -g @agentclientprotocol/claude-agent-acp\n\n# 设置 RCS 连接\nexport ACP_RCS_URL=http://rcs-host:3000\nexport ACP_RCS_TOKEN=sk-your-key\n\n# 启动桥接\nacp-link claude-agent-acp\n```\n\n接入后所有 agent 在 Web UI 中统一管理,团队成员可选择任意 agent 创建会话。\n\n## 安全建议\n\n- RCS 默认监听 0.0.0.0,生产环境建议用反代 + HTTPS\n- 用强 API Key,定期轮换\n- 生产环境关闭 `RCS_ALLOW_REGISTRATION` 改为邀请制\n- 使用 `RCS_WEB_CORS_ORIGINS` 限制 Web UI 访问来源\n- 设置 `RCS_DB_PATH` 持久化 SQLite 数据库\n- 限制 worker 的权限(`/permissions` 配置)\n- `bypassPermissions` 模式仅在 sandbox 环境中启用,避免在主机直接放行所有工具调用\n\n## 故障排查\n\n| 问题 | 排查 |\n|------|------|\n| Worker 无法连接 | 检查 `SALUZI_BRIDGE_BASE_URL` 和 `SALUZI_BRIDGE_OAUTH_TOKEN` 是否同时设置;确认 token 与 RCS 的 `RCS_API_KEYS` 匹配 |\n| `Only HTTPS or localhost HTTP is allowed` | 远程 RCS 用 HTTP 被拒。优先用 HTTPS;或 SSH 隧道转发到 localhost;可信内网可设 `SALUZI_BRIDGE_ALLOW_INSECURE_HTTP=1` |\n| Web UI 登录失败 | 检查用户名密码;5 次失败后锁定 5 分钟 |\n| Web UI 401 | 确认使用 `RCS_API_KEYS` 中的 key 或有效的 session token |\n| 看不到某个会话 | 检查会话 visibility(private/team/public);确认是否在所属团队的成员列表里;admin 可看所有 |\n| 环境显示「待认领」 | worker 没指定 `--user-id`/`--team-id`,找到终端里的 `/code/claim/clm_xxx` URL,已登录用户打开即可认领 |\n| acp-link 无法连接 RCS | 检查 `ACP_RCS_URL` 和 `ACP_RCS_TOKEN` 是否设置 |\n| Agent 不出现在 Web UI | 确认 acp-link 已启动且 `ACP_RCS_TOKEN` 与 `RCS_API_KEYS` 匹配 |\n| 邀请链接失效 | 邀请 token 可能过期或达到 max_uses 上限;让团队 owner/admin 重新创建 |\n| 会话超时 | 调整 `RCS_DISCONNECT_TIMEOUT` 和 `RCS_WS_CLIENT_INACTIVITY_TIMEOUT` |\n"
|
|
3230
3234
|
},
|
|
3231
3235
|
"docs/guide/context-tips": {
|
|
3232
3236
|
"frontmatter": {
|