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>
186 lines
8.3 KiB
Plaintext
186 lines
8.3 KiB
Plaintext
---
|
||
title: "Worktree 隔离 - Git Worktree 实现文件级隔离"
|
||
description: "揭秘 Claude Code 的 git worktree 隔离机制:子 Agent 如何获得独立工作空间,worktree 创建/销毁生命周期、路径命名规则和安全防护。"
|
||
keywords: ["Worktree", "git worktree", "文件隔离", "多 Agent 隔离", "并行安全"]
|
||
---
|
||
|
||
{/* 本章目标:揭示 worktree 的创建/销毁生命周期、路径命名规则、hook 机制和退出时的安全防护 */}
|
||
|
||
## 为什么需要文件级隔离
|
||
|
||
多 Agent 并行工作时,共享同一工作目录会导致三类冲突:
|
||
|
||
1. **写入冲突**:两个 Agent 同时编辑 `config.ts`,后写的覆盖前写的
|
||
2. **状态干扰**:Agent A 的测试依赖某个环境状态,Agent B 的修改破坏了它
|
||
3. **不可区分**:半完成的修改混在一起,无法分辨哪些是哪个 Agent 的
|
||
|
||
Git worktree 是 git 原生的解决方案——在同一个仓库中创建多个独立工作目录,每个在自己的分支上。
|
||
|
||
## 目录结构与命名规则
|
||
|
||
Worktree 文件统一存放在仓库根目录下的 `.claude/worktrees/`:
|
||
|
||
```
|
||
<repo-root>/
|
||
├── .claude/
|
||
│ └── worktrees/
|
||
│ ├── fix-auth-bug/ # worktree 工作目录
|
||
│ │ ├── .git # 指向主仓库的链接文件
|
||
│ │ └── src/... # 独立的文件系统视图
|
||
│ └── add-dark-mode/ # 另一个 worktree
|
||
│ └── ...
|
||
├── src/ # 主工作目录(不受影响)
|
||
└── .git/ # 主仓库
|
||
```
|
||
|
||
分支命名规则为 `worktree/<slug>`,其中 slug 由 `validateWorktreeSlug()` 校验:每个 `/` 分隔的段只允许字母、数字、`.`、`_`、`-`,总长 ≤64 字符。未指定时使用 plan slug 自动生成。
|
||
|
||
## 创建流程:EnterWorktreeTool
|
||
|
||
`EnterWorktreeTool`(`packages/builtin-tools/src/tools/EnterWorktreeTool/EnterWorktreeTool.ts`)的执行链路:
|
||
|
||
```
|
||
EnterWorktreeTool.call({ name? })
|
||
↓
|
||
1. 检查是否已在 worktree 中(防嵌套)
|
||
↓
|
||
2. 解析到主仓库根目录(findCanonicalGitRoot)
|
||
如果当前已在 worktree 内,chdir 到主仓库
|
||
↓
|
||
3. 生成 slug(用户提供或 plan slug)
|
||
↓
|
||
4. createWorktreeForSession(sessionId, slug)
|
||
├── 有 WorktreeCreate hook?
|
||
│ └── 执行 hook,返回 hook 指定的路径(支持非 git VCS)
|
||
└── 无 hook → git 原生路径:
|
||
a. getOrCreateWorktree(repoRoot, slug)
|
||
├── 快速恢复:检查 worktree 目录是否已存在
|
||
│ └── 读取 .git 指针文件的 HEAD SHA(无子进程)
|
||
└── 新建:
|
||
i. mkdir .claude/worktrees/(recursive)
|
||
ii. fetch origin/<default-branch>(有缓存则跳过)
|
||
iii. git worktree add -b worktree/<slug> <path> <base>
|
||
iv. performPostCreationSetup()(sparse checkout 等)
|
||
↓
|
||
5. 更新进程状态:
|
||
- process.chdir(worktreePath)
|
||
- setCwd(worktreePath)
|
||
- setOriginalCwd(worktreePath)
|
||
- saveWorktreeState(session) → 持久化到项目配置
|
||
- clearSystemPromptSections() → 重新计算系统提示中的 cwd 信息
|
||
- clearMemoryFileCaches() → 重新加载 worktree 中的 CLAUDE.md
|
||
↓
|
||
6. 返回 worktreePath 和 worktreeBranch
|
||
```
|
||
|
||
### Hook 优先的架构
|
||
|
||
`createWorktreeForSession()` 首先检查 `hasWorktreeCreateHook()`——如果用户在 settings.json 中配置了 `WorktreeCreate` hook,系统完全不调用 git,而是执行 hook 命令并将返回的路径作为 worktree 路径。这允许非 git 版本控制系统(如 Pijul、Mercurial)通过 hook 接入。
|
||
|
||
### 快速恢复路径
|
||
|
||
`getOrCreateWorktree()` 有一个关键优化:如果目标路径已存在,直接读取 `.git` 指针文件获取 HEAD SHA(纯文件 I/O,无子进程),跳过整个 `fetch` + `worktree add` 流程。在大仓库中 `fetch` 需要 6-8 秒,这个优化将恢复场景的延迟降到接近 0。
|
||
|
||
## 退出流程:ExitWorktreeTool
|
||
|
||
`ExitWorktreeTool`(`packages/builtin-tools/src/tools/ExitWorktreeTool/ExitWorktreeTool.ts`)支持两种退出策略:
|
||
|
||
### keep:保留 worktree
|
||
|
||
```
|
||
keepWorktree()
|
||
↓
|
||
1. chdir 回 originalCwd
|
||
2. 清空 currentWorktreeSession
|
||
3. 更新项目配置(activeWorktreeSession = undefined)
|
||
4. worktree 目录和分支保留在磁盘上
|
||
```
|
||
|
||
用户可以通过 `cd <worktreePath>` 继续工作,或稍后手动合并。
|
||
|
||
### remove:删除 worktree
|
||
|
||
有严格的**安全防护**:
|
||
|
||
```
|
||
validateInput() — 第一道防线
|
||
↓
|
||
1. 检查是否在 EnterWorktree 创建的会话中
|
||
(手动创建的 worktree 不会被删除)
|
||
↓
|
||
2. countWorktreeChanges(worktreePath, originalHeadCommit)
|
||
├── git status --porcelain → 统计未提交文件数
|
||
├── git rev-list --count <originalHead>..HEAD → 统计新提交数
|
||
└── 返回 null(git 失败时)→ fail-closed(拒绝删除)
|
||
↓
|
||
3. 有未提交文件或新提交?
|
||
→ 拒绝,要求 discard_changes: true 确认
|
||
```
|
||
|
||
```
|
||
call() — 实际执行
|
||
↓
|
||
1. 重新计数变更(validateInput 和 call 之间可能有新修改)
|
||
2. 如果有 tmux session → killTmuxSession()
|
||
3. cleanupWorktree()
|
||
├── hook-based → 执行 WorktreeRemove hook
|
||
└── git-based → git worktree remove --force + git branch -D
|
||
4. restoreSessionToOriginalCwd()
|
||
- setCwd(originalCwd)
|
||
- setOriginalCwd(originalCwd)
|
||
- 如果 projectRoot 是 worktree 时才恢复(防误触)
|
||
- 更新 hooks config snapshot
|
||
- 清空系统提示和 memory 缓存
|
||
```
|
||
|
||
### fail-closed 设计
|
||
|
||
`countWorktreeChanges()` 在以下情况返回 `null`("未知,假设不安全"):
|
||
- `git status` 或 `git rev-list` 退出非零(锁文件、损坏的索引)
|
||
- `originalHeadCommit` 未定义(hook-based worktree 没有设置基线 commit)
|
||
|
||
返回 `null` 时,`validateInput` 拒绝删除——宁可让用户手动处理,也不冒险丢失工作。
|
||
|
||
## 与 Agent 工具的联动
|
||
|
||
Agent 工具(`AgentTool`)的 `isolation` 参数决定子 Agent 是否在 worktree 中运行。注意 Agent 工具使用**专用的** `createAgentWorktree()`(`src/utils/worktree.ts`),而非用户会话用的 `createWorktreeForSession()`,两者有关键差异:
|
||
|
||
| 维度 | `createWorktreeForSession`(用户会话) | `createAgentWorktree`(子 Agent) |
|
||
|------|---------------------------------------|----------------------------------|
|
||
| 调用者 | EnterWorktreeTool | AgentTool |
|
||
| Session 管理 | 设置 `currentWorktreeSession` | **不设置** `currentWorktreeSession` |
|
||
| 恢复已有 worktree | 直接复用 | 复用并 bump mtime(防止被周期性清理误删) |
|
||
|
||
子 Agent 结束时的处理由 `cleanupWorktreeIfNeeded()` 自动完成——它不走 `ExitWorktreeTool`(因为 Agent worktree 没有会话状态,`ExitWorktreeTool` 的 `validateInput` 会拒绝):
|
||
- **有变更** → 保留 worktree,返回 `worktreePath` 供主 Agent 后续合并
|
||
- **无变更** → 自动删除
|
||
- **Hook-based** → 始终保留
|
||
|
||
## Session 状态持久化
|
||
|
||
`WorktreeSession` 对象通过 `saveCurrentProjectConfig()` 持久化到磁盘,包含:
|
||
|
||
```typescript
|
||
{
|
||
originalCwd: string, // 进入 worktree 前的工作目录
|
||
worktreePath: string, // worktree 的绝对路径
|
||
worktreeName: string, // slug
|
||
worktreeBranch?: string, // 分支名(如 worktree/fix-auth)
|
||
originalBranch?: string, // 进入前的分支
|
||
originalHeadCommit?: string, // 进入前的 HEAD commit(用于变更统计)
|
||
sessionId: string, // 创建此 worktree 的会话 ID
|
||
tmuxSessionName?: string, // 关联的 tmux session
|
||
hookBased?: boolean, // 是否由 hook 创建
|
||
creationDurationMs?: number, // 创建耗时(分析用)
|
||
usedSparsePaths?: boolean, // 是否使用了 sparse checkout
|
||
}
|
||
```
|
||
|
||
这使得 session 恢复(`--resume`)时能正确还原 worktree 上下文——即使进程重启,`getCurrentWorktreeSession()` 从项目配置中读取状态。
|
||
|
||
## Sparse Checkout 优化
|
||
|
||
对于大型 monorepo,worktree 支持 `sparsePaths` 配置——只检出特定目录而非整个仓库。这在 210K 文件的仓库中将 worktree 创建时间从数十秒降到几秒。
|
||
|
||
配置位于 `getInitialSettings().worktree?.sparsePaths`,在 `performPostCreationSetup()` 中应用。
|