mirror of
https://github.com/claude-code-best/claude-code.git
synced 2026-06-15 21:05:51 +00:00
* docs: 修复文档巡检发现的 4 处错误 - daemon.md: 反映实际实现状态(supervisor/worker 已实现而非 stub) - bridge-mode.md: API 操作数量从 7 修正为 9 - web-search-tool.md: 文件路径从 src/tools/ 修正为 packages/builtin-tools/src/tools/ - remote-control-self-hosting.md: 补充缺失的 RCS_WS_IDLE_TIMEOUT 和 RCS_WS_KEEPALIVE_INTERVAL 配置项 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 Safety 和 Context 文档中的代码引用和类型错误 - permission-model: 修正规则来源从"五层"到八层,优先级顺序对齐代码 - permission-model: PermissionUpdate 类型改为实际的 addRules/replaceRules 等 - permission-model: 补充 acceptEdits 和 dontAsk 两种权限模式 - permission-model: DENIAL_LIMITS 字段名对齐实际代码 - plan-mode: 工具路径从 src/tools/ 改为 packages/builtin-tools/src/tools/ - compaction: 修正 COMPACTABLE_TOOLS 和 POST_COMPACT_* 的行号 - project-memory: 修正 ENTRYPOINT_NAME 常量的行号 - system-prompt: 修正 SystemPrompt 类型定义文件路径和多个行号引用 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修复 introduction 文档中的错误路径和行号引用 - why-this-whitepaper.mdx: BashTool 路径从 src/tools/ 修正为 packages/builtin-tools/src/tools/ - what-is-claude-code.mdx: 移除不存在的 Azure provider,改为实际的 7 种 provider - architecture-overview.mdx: State 类型行号从 204 修正为 207 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修复 conversation/features 文档中的错误 - streaming.mdx: queryStreamRaw → queryModelWithStreaming 函数名修正 - streaming.mdx: Azure 提供商不存在,替换为实际 7 个提供商 - debug-mode.mdx: --inspect-wait 描述错误,实际使用 BUN_INSPECT 环境变量 - buddy.mdx: 补充缺失的 companionReact.ts、CompanionCard.tsx、index.ts Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修复文档巡检中的源码引用错误 - feature-flags.mdx: 修正 feature() 兜底描述,实际从 bun:bundle 导入而非 cli.tsx:3 内联 - feature-flags.mdx: 修正工具 require 路径为 @claude-code-best/builtin-tools 包路径 - ant-only-world.mdx: 修正 tools.ts 中 require 路径为包路径 - ant-only-world.mdx: 修正 INTERNAL_ONLY_COMMANDS 行号 (267-295) 和数量 (24+) - skills.mdx: 修正 COMMANDS memoize 行号 258 → 299 - mcp-protocol.mdx: 修正 fetchToolsForClient LRU 缓存上限 20 → 100 - streaming.mdx: 修正流式事件引用 - file-operations.mdx: 修正工具路径引用 - search-and-navigation.mdx: 修正搜索工具引用 - shell-execution.mdx: 修正 shell 工具引用 - buddy.mdx: 补充缺失的 frontmatter 字段 - debug-mode.mdx: 修正调试模式描述 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 tools/agent 文档中的文件路径和行号引用 - 修正 TodoWriteTool、AgentTool、ToolSearchTool 等工具路径 src/tools/ → packages/builtin-tools/src/tools/ - 更新 Tool.ts、tools.ts、BashTool.tsx 中过时的行号引用 - 修正 WebSearchTool/WebFetchTool/EnterWorktreeTool/ExitWorktreeTool 路径 - 修正 AgentTool.tsx 中多行行号引用 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 feature 文档中的文件路径和行号引用 - ultraplan.md: 更新文件行数(525/349/127) - fork-subagent.md: 路径迁移 src/tools/ → packages/builtin-tools/ - mcp-skills.md: 修正 getMcpSkillCommands 行号 547→604,client.ts 行号 117→129 - kairos.md: 修正 getBriefSection/getProactiveSection 行号 - proactive.md: 修正 getProactiveSection 行号 860→864 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正顶层文档中的路径迁移和行号引用 - auto-updater.md: config.ts 行号 1735→1737,标注未接入启动流程的函数 - external-dependencies.md: WebSearchTool/WebFetchTool 路径迁移到 builtin-tools 包,Vertex 行号修正 - lsp-integration.md: LSPTool 路径从 src/tools/ 迁移到 packages/builtin-tools/ - stub-recovery-design-1-4.md: 修正 Windows 绝对路径链接为标准代码引用 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 task 文档中的文件扩展名和路径引用 - task-004: AssistantSessionChooser.ts → .tsx, assistant.ts → .tsx - task-003: cli.tsx 行号 249→272, markdownConfigLoader.ts 行号 29→35 - lan-pipes: SendMessageTool 路径迁移到 packages/builtin-tools/ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 补充 computer-use-tools-reference 缺失的 Windows 工具 添加遗漏的 open_terminal 和 activate_window 两个 Windows 专属工具, 修正工具总数 37→39,Windows 工具数 10→12。 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 audit/bash-classifier/token-budget/tree-sitter 文档 - feature-flags-audit: ScheduleCronTool 路径迁移、DAEMON 状态更新为 COMPLETE、assistant 文件标记已补全、UDS 标记已实现 - bash-classifier: BashPermissionRequest 文件路径修正、withRetry 行号移除 - token-budget: attachments.ts 行号范围修正 - tree-sitter-bash: bashPermissions.ts 路径迁移到 packages/builtin-tools Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 langfuse-monitoring AgentTool 路径迁移 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 bridgeApi 行号和 Tool.ts 行号引用 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 Safety/Extensibility 文档中的工具路径迁移和行号引用 - sandbox.mdx: shouldUseSandbox.ts 和 bashPermissions.ts 路径迁移至 packages/builtin-tools - why-safety-matters.mdx: bashPermissions.ts 路径迁移(3 处) - plan-mode.mdx: EnterPlanModeTool/prompt.ts 路径迁移 - auto-mode.mdx: Auto mode 指令行号 3464→3481 - hooks.mdx: AgentTool/runAgent.ts 路径迁移 - skills.mdx: SkillTool.ts 路径迁移 - custom-agents.mdx: Agent built-in 目录和 exploreAgent.ts 路径迁移 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 internals 文档引用计数和路径 - ant-only-world: USER_TYPE 引用计数 465→410+,工具路径迁移到 builtin-tools - growthbook-ab-testing: growthbook.ts 行数 1156→1258 - hidden-features: 语音模式状态更新(audio-napi 已恢复) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正工具文档中的行号引用 - sub-agents: AgentTool.call 入口行号 340→387 - shell-execution: ShellCommand onTimeout 行号 129→144 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 feature 文档中的状态、路径和计数 - all-features-guide: 修正 feature flag 启用范围(dev only vs dev+build) - tier3-stubs: 大量状态修正(stub→已实现),缩减过时条目 - workflow-scripts: 路径迁移到 builtin-tools,状态更新 - web-browser-tool: 工具状态缺失→已实现,路径迁移 - context-collapse: CtxInspectTool 状态缺失→已实现 - computer-use: 行号引用更新,平台分发描述修正 - computer-use-tools-reference: 工具数 39→38 - voice-mode: voiceModeEnabled 行数 55→54 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 更新 the-loop 查询循环行号引用 query.ts 代码变更后终止原因行号整体偏移约 40 行 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 补充 feature-flags-audit 完整 build 默认 feature 列表 添加 ULTRATHINK/LODESTONE/ACP/DAEMON 等 19 个缺失的 build 默认 feature, 修正 dev-only 特征标注(UDS_INBOX/LAN_PIPES/BG_SESSIONS/TEMPLATES) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 feature-flags-audit ConfigTool 路径迁移 ConfigTool 路径从 src/tools/ 迁移到 packages/builtin-tools/src/tools/ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 feature-flags-audit BashTool 路径迁移 BashTool 路径从 src/tools/ 迁移到 packages/builtin-tools/src/tools/ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 修正 feature-flags-audit SkillTool 路径迁移 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: 更新 feature-flags-audit WorkflowTool 状态为已实现 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
159 lines
6.3 KiB
Markdown
159 lines
6.3 KiB
Markdown
# BRIDGE_MODE — 远程控制
|
||
|
||
> Feature Flag: `FEATURE_BRIDGE_MODE=1`
|
||
> 实现状态:完整可用(v1 + v2 实现)
|
||
> 引用数:28
|
||
|
||
## 一、功能概述
|
||
|
||
BRIDGE_MODE 将本地 CLI 注册为"bridge 环境",可从 claude.ai 或其他控制面远程驱动。本地终端变为一个"执行者",接受远程指令并执行。
|
||
|
||
### 核心特性
|
||
|
||
- **环境注册**:本地 CLI 向 Anthropic 服务器注册为可用的 bridge 环境
|
||
- **工作轮询**:长轮询(long-poll)等待远程任务分配
|
||
- **会话管理**:创建、恢复、归档远程会话
|
||
- **权限透传**:远程权限请求发送到控制面,用户在 claude.ai 上批准/拒绝
|
||
- **心跳保活**:定期发送 heartbeat 延长任务租约
|
||
- **可信设备**:v2 支持可信设备令牌增强安全性
|
||
|
||
## 二、实现架构
|
||
|
||
### 2.1 版本演进
|
||
|
||
| 版本 | 实现 | 特点 |
|
||
|------|------|------|
|
||
| v1(env-based) | `src/bridge/replBridge.ts` | 基于环境变量的传统 bridge |
|
||
| v2(env-less) | `src/bridge/remoteBridgeCore.ts` | 无需环境变量,更安全的 bridge |
|
||
|
||
### 2.2 API 协议
|
||
|
||
文件:`src/bridge/bridgeApi.ts`
|
||
|
||
Bridge API Client 提供 9 个核心操作:
|
||
|
||
| 操作 | HTTP | 说明 |
|
||
|------|------|------|
|
||
| `registerBridgeEnvironment` | POST `/v1/environments/bridge` | 注册本地环境,获取 `environment_id` + `environment_secret` |
|
||
| `pollForWork` | GET `/v1/environments/{id}/work/poll` | 长轮询等待任务(10s 超时) |
|
||
| `acknowledgeWork` | POST `/v1/environments/{id}/work/{workId}/ack` | 确认接收任务 |
|
||
| `stopWork` | POST `/v1/environments/{id}/work/{workId}/stop` | 停止任务 |
|
||
| `heartbeatWork` | POST `/v1/environments/{id}/work/{workId}/heartbeat` | 续约任务租约 |
|
||
| `deregisterEnvironment` | DELETE `/v1/environments/bridge/{id}` | 注销环境 |
|
||
| `archiveSession` | POST `/v1/sessions/{id}/archive` | 归档会话(409 = 已归档,幂等) |
|
||
| `sendPermissionResponseEvent` | POST `/v1/sessions/{id}/events` | 发送权限审批结果 |
|
||
| `reconnectSession` | POST `/v1/environments/{id}/bridge/reconnect` | 重连已存在的会话 |
|
||
|
||
### 2.3 认证流程
|
||
|
||
```
|
||
注册: OAuth Bearer Token → 获取 environment_secret
|
||
轮询: environment_secret 作为 Authorization
|
||
├── 401 → 尝试 OAuth token 刷新(onAuth401)
|
||
└── 刷新成功 → 重试一次
|
||
```
|
||
|
||
**OAuth 刷新**:API client 内置 `withOAuthRetry` 机制。401 时调用 `handleOAuth401Error`(同 withRetry.ts 的 v1/messages 模式),刷新后重试一次。
|
||
|
||
### 2.4 安全设计
|
||
|
||
- **路径穿越防护**:`validateBridgeId()` 使用 `/^[a-zA-Z0-9_-]+$/` 白名单验证所有服务端 ID
|
||
- **BridgeFatalError**:不可重试的错误(401/403/404/410)直接抛出,阻止重试循环
|
||
- **可信设备令牌**:v2 通过 `X-Trusted-Device-Token` header 增强安全层级
|
||
- **幂关注册**:支持 `reuseEnvironmentId` 实现会话恢复,避免重复创建环境
|
||
|
||
### 2.5 数据流
|
||
|
||
```
|
||
claude.ai 用户选择远程环境
|
||
│
|
||
▼
|
||
POST /v1/environments/bridge (注册)
|
||
│
|
||
◀── environment_id + environment_secret
|
||
│
|
||
▼
|
||
GET .../work/poll (长轮询)
|
||
│
|
||
◀── WorkResponse { id, data: { type, sessionId } }
|
||
│
|
||
▼
|
||
POST .../work/{id}/ack (确认)
|
||
│
|
||
▼
|
||
sessionRunner 创建 REPL session
|
||
│
|
||
├── 权限请求 → sendPermissionResponseEvent
|
||
├── 心跳 → heartbeatWork (续约)
|
||
└── 任务完成 → 自动归档
|
||
```
|
||
|
||
### 2.6 模块结构
|
||
|
||
| 模块 | 文件 | 职责 |
|
||
|------|------|------|
|
||
| API Client | `bridgeApi.ts` | HTTP 通信(注册/轮询/确认/心跳/注销) |
|
||
| Session Runner | `sessionRunner.ts` | 创建/恢复 REPL 会话 |
|
||
| Bridge Config | `bridgeConfig.ts` | 配置管理(machine name、max sessions 等) |
|
||
| Transport | `replBridgeTransport.ts` | Bridge 传输层 |
|
||
| Permission Callbacks | `bridgePermissionCallbacks.ts` | 权限请求处理 |
|
||
| Pointer | `bridgePointer.ts` | 当前活跃 bridge 状态指针 |
|
||
| Flush Gate | `flushGate.ts` | 刷新控制 |
|
||
| JWT Utils | `jwtUtils.ts` | JWT 令牌工具 |
|
||
| Trusted Device | `trustedDevice.ts` | 可信设备管理 |
|
||
| Debug Utils | `debugUtils.ts` | 调试日志 |
|
||
| Types | `types.ts` | 类型定义 |
|
||
|
||
## 三、关键设计决策
|
||
|
||
1. **长轮询而非 WebSocket**:`pollForWork` 使用 HTTP GET + 10s 超时。简单可靠,无需维护 WebSocket 连接
|
||
2. **OAuth 刷新内嵌**:API client 自带 `withOAuthRetry`,无需外层重试逻辑
|
||
3. **ETag 条件请求**:注册时支持 `reuseEnvironmentId` 实现幂等会话恢复
|
||
4. **v1/v2 共存**:代码中同时存在两套实现,v2 是更安全的升级版
|
||
5. **权限双向流动**:本地权限请求发送到 claude.ai,用户在 web 上审批
|
||
|
||
## 四、使用方式
|
||
|
||
```bash
|
||
# 启用 bridge mode
|
||
FEATURE_BRIDGE_MODE=1 bun run dev
|
||
|
||
# 从 claude.ai/code 远程连接
|
||
# 在 web 界面选择已注册的环境
|
||
|
||
# 配合 DAEMON 使用(后台守护)
|
||
FEATURE_BRIDGE_MODE=1 FEATURE_DAEMON=1 bun run dev
|
||
```
|
||
|
||
## 五、外部依赖
|
||
|
||
| 依赖 | 说明 |
|
||
|------|------|
|
||
| Anthropic OAuth | claude.ai 订阅登录 |
|
||
| GrowthBook | `tengu_ccr_bridge` 门控 |
|
||
| Bridge API | `/v1/environments/bridge` 系列端点 |
|
||
|
||
## 六、文件索引
|
||
|
||
| 文件 | 行数 | 职责 |
|
||
|------|------|------|
|
||
| `src/bridge/bridgeApi.ts` | 541 | API Client(核心) |
|
||
| `src/bridge/sessionRunner.ts` | — | 会话运行器 |
|
||
| `src/bridge/bridgeConfig.ts` | — | 配置管理 |
|
||
| `src/bridge/replBridgeTransport.ts` | — | 传输层 |
|
||
| `src/bridge/bridgePermissionCallbacks.ts` | — | 权限回调 |
|
||
| `src/bridge/bridgePointer.ts` | — | 状态指针 |
|
||
| `src/bridge/flushGate.ts` | — | 刷新控制 |
|
||
| `src/bridge/jwtUtils.ts` | — | JWT 工具 |
|
||
| `src/bridge/trustedDevice.ts` | — | 可信设备 |
|
||
| `src/bridge/remoteBridgeCore.ts` | — | v2 核心实现 |
|
||
| `src/bridge/types.ts` | — | 类型定义 |
|
||
| `src/bridge/debugUtils.ts` | — | 调试工具 |
|
||
| `src/bridge/pollConfigDefaults.ts` | — | 轮询配置默认值 |
|
||
| `src/bridge/bridgeUI.ts` | — | UI 组件 |
|
||
| `src/bridge/codeSessionApi.ts` | — | 代码会话 API |
|
||
| `src/bridge/peerSessions.ts` | — | 对等会话管理 |
|
||
| `src/bridge/sessionIdCompat.ts` | — | Session ID 兼容层 |
|
||
| `src/bridge/createSession.ts` | — | 会话创建 |
|
||
| `src/bridge/replBridgeHandle.ts` | — | Bridge 句柄 |
|