Agent Worktree 工具#

Agent 在用户真实代码仓库里跑高风险改动时，工作在一个隔离的临时目录里： 改好了 merge 回主线，改坏了一次 discard 清掉，主仓库不受影响。 底层是 git worktree add / git worktree remove 的封装，与 OpenProgram 自己的 session-git 严格区分。

切 cwd、跑状态机、退出时 keep 或 discard 这套骨架来自 Claude Code 的 EnterWorktreeTool / ExitWorktreeTool （references/claude-code-leaked/src/tools/EnterWorktreeTool/）， 适配到 OpenProgram 的 runtime / session 模型。

Part 1. 设计维度#

D1. Worktree 实体存什么#

每个 active worktree 是一条记录，字段：

• id: worktree 短 id（hex，跟 commit id 风格一致）
• source_repo: 用户真实仓库 root（绝对路径）
• worktree_path: git worktree add 落地的目录（绝对路径）
• branch_name: worktree 上对应的分支名（默认 op/wt/<id>）
• base_ref: 创建时的基线 ref（默认 HEAD，可指定 origin/main / commit sha）
• created_at: unix 时间戳
• status: active / committing / merged / discarded / kept
• parent_session_id: 关联的 OpenProgram session（一对一或一对多）
• parent_job_id: 关联的 async task（若有）
• created_by_agent: agent id（记录是哪个 agent 开的，UI 上能看出来）
• pr_number: 通过 worktree_create 的 pr 参数开出来的 worktree 会记这个值（见 D5b）； 后续再对同一个 PR 号调用 pr 模式时，靠它识别出重复而不是再开一个

记录持久化在 session-git 仓库的 worktrees/<id>.json，跟 ContextCommit 平行存。 session 关闭时不自动清理，等 agent 或用户显式 merge / discard。

D2. cwd 切换机制#

OpenProgram 的工具分两类：

1. Runtime-spawned subprocess（Codex CLI / Claude CLI 这种带 --cd 参数的） 通过 runtime.set_workdir(path) 控制。
2. In-process @function 工具（bash / edit / write / read 等） bash 走 get_active_backend().run(...)，目前 LocalBackend.run 接收 cwd 参数但调用方没传；edit / write / read 强制要求绝对路径。

openprogram/programs/_runtime.py 里的 ContextVar _current_worktree_path: Optional[str] 承载当前路径。dispatcher 每次进 turn 时， 若 session 当前有 active worktree（从 session meta 读），就 set 这个 var。 工具实现按需消费：

• bash：LocalBackend.run(cmd, cwd=_current_worktree_path.get())
• edit / write / read：相对路径解析时以 _current_worktree_path 为根； 绝对路径必须在 worktree 之下（D6 安全校验）。
• runtime 子进程：apply_default_workdir(runtime, session_id) 优先返回 worktree path（若有），否则 session-git 的 workdir/。

没有显式 cwd 参数。worktree 是 session 级别的上下文，工具不感知。

D3. 状态机#

            create
              │
              ▼
        ┌─ active ─┐
        │          │
  merge │          │ discard
        │          │
        ▼          ▼
     merged    discarded
        │          │
        └────┬─────┘
             │ keep
             ▼
           kept (用户决定保留分支但不 merge 也不删)

• active: agent 正在用。bash / edit 这类工具 cwd 默认指向这里。
• committing: 短暂状态，merge 操作期间持锁，防止并发改文件。
• merged: git merge 成功，worktree 目录已 git worktree remove。
• discarded: git worktree remove --force 成功，分支也删了。
• kept: 用户走 worktree_keep —— worktree 目录保留，OpenProgram 解绑这条记录但不动 git。后续用户自己接管。

D4. 跟 OpenProgram session-git 的隔离#

OpenProgram 自己有 ~/.openprogram/sessions/<sid>/（每个 session 一个 git repo）， 存对话内存的 history / context / workdir。agent worktree 绝不落地 在这个目录树里：

• worktree_path 必须不在任何 ~/.openprogram/sessions/* 之下（D14 校验）。
• source_repo 不能等于 session-git 仓库路径。
• session-git 的 commit 跟 worktree 的 commit 各管各的；UI 上 ContextCommit 时间线只看 session-git，worktree 时间线另一个 panel 显示。

早先有过一套 sub-agent worktree 机制，落地在 <session-repo>/_worktrees/<branch>/， 后来被"sub-agent = peer session + attach"取代。本设计不复用那条路径—— 那个是在 session-git 内部开分支跑 sub-agent，本设计是在用户真实代码 仓库开 worktree 给 agent 跑改动，两者用途无关。

D5. Source repo 来源#

两个入口，优先级从高到低：

1. agent 显式传：worktree_create 工具的 source_repo 参数（绝对路径）。 适合 plan agent 列任务时已经知道目标仓库。
2. 选中的 Project：dispatcher 把会话 Project 目录绑定为 cwd，再通过 git rev-parse --show-toplevel 解析其祖先 git root。

入口都失败 → worktree_create 报错 source_repo_not_a_git_repo。 不会自动 git init 给用户建仓库（破坏性太大）。

D5b. 直接从 PR 开 worktree#

worktree_create 的 pr 参数让 worktree 直接开在某个 PR 的分支上，替代 base_ref—— 接受纯数字（123）、# 前缀（#123）、或完整 GitHub PR 链接 （https://github.com/<owner>/<repo>/pull/<number>）。解析逻辑在 openprogram/worktree/pr_ref.py::parse_pr_ref。这条路复用同一个 worktree_create 工具和同一条 WorktreeManager.create_worktree 创建路径——pr 是这唯一入口上的一种 模式切换，不是另起一个工具。

解析走 gh CLI（openprogram/worktree/pr_ref.py）：

1. gh pr view <n> --json headRefName,headRepositoryOwner,isCrossRepository 读 PR 的 head 分支和是否来自 fork。
2. 同仓 PR（isCrossRepository=false）：git fetch origin <headRefName>:<local_branch>—— 分支已经在 origin 上。
3. fork PR（isCrossRepository=true）：git fetch origin pull/<n>/head:<local_branch>—— GitHub 提供的每个 PR 一个的合成 ref，跟 gh pr checkout 用的机制一样，不需要把 贡献者的 fork 注册成 remote。
4. fetch 到的 commit 作为普通 git worktree add 的 base_ref；worktree 自己的分支名是 op/wt/pr-<n>-<id6>（跟其它 worktree 一样的 op/wt/<slug>-<id6> 命名惯例，用 PR 号 顶替 label 位置）。临时 fetch ref 在 -b 把它的 tip 拷到新分支后就删掉。

gh 缺失或未登录会报 pr_ref_error: gh_not_found / gh_not_authenticated——绝不 静默退回 base_ref。同一 PR 号已存在一个非终态 worktree（Worktree.pr_number）时报 pr_worktree_exists，报出已有 worktree 的 id 和路径，而不是重复创建。

D6. 安全 / 权限#

worktree 内 agent 工具的核心安全约束：bash 命令的 cwd 锁定，但 cmd 内可以 cd .. 跑到 worktree 外。这不是真正的 sandbox，只是设定默认位置。 两层补救：

• 绝对路径校验：edit / write / read 收到 file_path 时，若它落在 worktree_path 之外，记一条 warning 进 ContextCommit metadata （outside_worktree=true），但不阻止——用户可能确实要读 system 配置。
• bash 的 cwd 永远是 worktree_path：即使 LLM 写了 cd /tmp && rm -rf X， 起点是 worktree_path，shell session 不持久（每条 bash 都是新 subprocess）， 下次 bash 又回 worktree_path。

不在范围内：bash 命令的 chroot / namespace 隔离。OpenProgram 已经支持 docker backend，要 hard sandbox 走那条路。

D7. Worktree 内的 commit#

agent 在 worktree 里写文件 → worktree 目录是脏的。两种语义：

• 自动 commit：agent 工具调用之后（bash 跑 git add / edit / write）， worktree 工具不自动 commit。由 agent 自己用 bash 跑 git add -A && git commit。 这样 commit message 由 agent 决定，符合 git 习惯。
• merge 时强制 commit：worktree_merge 时若 worktree 有 uncommitted changes，先报错 worktree_dirty，让 agent 显式处理（commit 掉 / stash 掉 / discard 掉）。不自动 commit-and-merge。

D8. Merge 策略#

worktree_merge(worktree_id, mode="ff-only" | "squash" | "no-ff")，默认 ff-only。

• ff-only: source_repo 的 HEAD 是 worktree branch 的祖先 → fast-forward。 否则报错 not_fast_forward，让 agent 决定是 rebase 还是切到 squash。
• squash: git merge --squash <branch> → 多个 worktree commit 压成一条； 适合 worktree 内是探索性多次小 commit 的情形。
• no-ff: 总是创建 merge commit，保留 worktree 的 commit 历史。

merge 之后默认 git worktree remove <path> 删掉 worktree 目录，但 branch 保留（让用户能 git log 看到这次改动的历史）。 冲突的处理：merge 失败时不自动 reset，worktree 状态保持 committing （实际上回滚到 active），让 agent 或用户进 worktree 手动解决冲突。

D9. Discard 语义#

worktree_discard(worktree_id, force=False):

• force=False（默认）：worktree 必须 clean（没有 uncommitted / untracked）。 否则报错 worktree_dirty，agent 可以决定是 stash 还是 force。
• force=True：git worktree remove --force <path> + git branch -D <branch>。 uncommitted 改动直接丢。
• 记录在 worktrees/.json 里 status 改成 discarded + 时间戳。文件不删， 方便审计——但 worktree_path 已经不存在了。

discard 前不做自动备份。把丢弃的内容打 tar 塞 ~/.openprogram/discarded/ 成本不高，可以以后再加，列在 Part 6。

D10. Worktree 跟 task 的关系#

async task 系统（见 async-job-lifecycle.md）：

• 一个 task 可以独占创建并使用 worktree（task_create → worktree_create）。
• task cancel 时，task 持有的 worktree 默认走 discard force=True。 task complete 时不自动 merge——让 task 完成后由 plan agent / 用户 显式决定（plan agent 看了 3 个 task 的产出后挑一个 merge）。
• 一个 task 没强制要求开 worktree。轻量 task（读文件、跑 grep）直接在 source_repo 上跑就行，不开 worktree。

实现上，task lifecycle 在 cancel hook 里调 worktree_manager.discard_for_task(task_id)。

D11. Worktree 跟 ContextCommit 的关系#

agent 在 worktree 里跑工具，工具结果（bash stdout / edit confirmation） 正常进 ContextCommit 的 items。worktree 里的 file diff 不直接进 ContextCommit 内容——文件 diff 是 git 的事，ContextCommit 只记"工具调用 X 修改了文件 Y" 这类事件级别的事实。

每条工具 item 的 metadata 里带一个轻量字段 worktree_id: Optional[str]， 标明这条工具调用发生在哪个 worktree 上（None 就是在 source_repo 直接跑）。 UI 渲染时给 worktree 内的工具调用加个角标。

worktree merge / discard 操作本身也写进 ContextCommit，作为 system 节点 （类似 attach pointer 的 marker），content 是 "Merged worktree wt_abc1234 into source_repo (ff-only, 3 files changed)"。

D12. Agent 工具暴露#

四个工具：

错误码（返回 error 字符串前缀）:

• not_a_git_repo: source_repo 不是 git repo
• worktree_dirty: worktree 有 uncommitted changes
• not_fast_forward: merge 时不能 ff
• merge_conflict: merge 期间冲突
• worktree_in_sessions_dir: source_repo 落在 sessions 树里（D4 隔离违例）
• worktree_exists: 同 source_repo 下同名 branch 已有 worktree
• pr_ref_error: pr 解析不出来，或 gh 缺失 / 未登录 / 调用失败（D5b）
• pr_worktree_exists: 同一个 PR 号已经有非终态 worktree（D5b）

worktree_create / worktree_merge / worktree_discard 默认 requires_approval=True，permission_mode=auto 才不弹审批。

没有 worktree_switch 工具。一个 session 同时只有一个 active worktree （D2 的 ContextVar 是单值），而切换会带出一串问题（要不要写一条切换 marker？ 切换后老 worktree 怎么算？），收益不抵成本。多 worktree 通过 async task 实现，每个 task 一个 worktree。

D13. UI 表达#

• Composer 工具栏：当前 session 有 active worktree 时，PromptInput 上方 显示一个 chip worktree: wt_abc1234 (3 files changed)，hover 弹 panel 显示 worktree_path / branch / 改动文件列表 / Merge / Discard / Keep 按钮。
• 函数表单：只包含函数参数。选中的 Project 仍是 source_repo，worktree 不在表单中显示。
• DAG 时间线：worktree create / merge / discard marker 节点用区分色 渲染（跟 attach marker 一致风格）。
• 不在范围内：worktree 文件 diff 的内联预览（用户可以点开"open in editor" / 用户自己的 git GUI 看）。

D14. 错误 / 边界#

• source_repo 不是 git repo → not_a_git_repo 错误，提示用户先 git init。
• source_repo 有 uncommitted changes 但 worktree 是新分支 → OK， worktree 从 base_ref（默认 HEAD）创建，不受 source_repo working tree 状态影响。
• worktree_path 已存在 → worktree_exists 错误。允许用户传 name 重试。
• source_repo 在 sessions 树里 → worktree_in_sessions_dir 拒绝（D4）。
• base_ref 不存在 → git 自己报错，工具透传 stderr。
• agent 误删 worktree_path（绕过 worktree_discard 直接 rm -rf）→ 下次 worktree_list 探测到 path 不存在时自动标记 status=discarded 并写一条 "auto-cleaned" 记录。

D15. 跟 Async Task 的整合#

worktree_create / merge / discard 本身是同步工具（git 子进程），不 wrap 成 async task。但worktree 内的长时间工作（agent 跑测试、跑 build） 通常是 async task 的工作内容：

• async task 启动时可以指定 worktree_id（task 的 cwd 锁定到这个 worktree）。
• task 内部跑的 bash / edit 也走 D2 的 ContextVar 路径，cwd 是 worktree_path。
• task cancel hook → 调 worktree_manager.on_task_cancel(task_id)， 默认 discard。
• task complete 不自动 merge（D10）。

Part 2. 场景 × 维度#

场景 A: 单 agent 单 worktree（基础流程）#

agent 接到任务"改 foo.py 加个 logging"，开 worktree → 改 → 跑测试 → merge。

场景 B: 单 agent 多次 worktree（探索失败）#

agent 试方案 A 跑测试不过 → discard → 试方案 B → 通过 → merge。

场景 C: 并发 worktree（plan agent 分发 3 个 task）#

plan agent 列 3 个独立改动 → 3 个 async task，每个 task 一个 worktree （独立 source_repo 副本）→ 全跑完 → plan agent 看结果挑一个 merge，其余 discard。

场景 D: 长时间 worktree / 用户接管#

agent 跑到一半（worktree 里 commit 了 5 个 patch），用户决定自己接手。

Part 3. 关键不变式#

1. worktree_path 永远不在 ~/.openprogram/sessions/ 子树里 （隔离 OpenProgram 自己的 git，违反则 worktree_create 拒绝）。

2. discard 后主仓库零改动 git worktree remove --force + git branch -D 不动 source_repo 的 HEAD 和 working tree。校验：discard 前后 git rev-parse HEAD 一致。

3. merge 失败时 worktree 不自动消失 merge_conflict / not_fast_forward 错误后，worktree status 回 active， 目录保留，让 agent 或用户手动看。

4. 同一 session 同一时刻最多一个 active worktree session.meta.active_worktree_id 是单值；worktree_create 时若已有 active， 报错 already_active，提示先 merge/discard/keep。

5. bash 命令的 cwd 起点永远是 active worktree_path（若存在） 而不是 session-git workdir/；多次 bash 调用之间不持久 shell state，每条 都是新 subprocess，cwd 都重置回 worktree_path。

6. worktree_id 在工具 item metadata 里出现 = 这次工具调用在那个 worktree 内执行 ContextCommit 读取时能据此区分"在哪儿改的"。

7. kept worktree 的 branch 不删 只解绑 OpenProgram 的引用；用户的 git 仓库里还能 git checkout 到这个 branch。

第四部分：.worktreeinclude#

git worktree add只checkout已跟踪的内容。仓库故意保持未跟踪且被 gitignore 的文件 （.env、按机器分的 TLS 证书、*.local.json 覆盖项）不会出现在新建的 worktree 里， 但 agent 的工具马上就要用到它们。

source_repo/.worktreeinclude存在时，每行是一条 gitignore 风格的 pattern：

• 去掉首尾空白后以#开头的行是注释；空行忽略。
• *、?、[...]——标准 glob 通配符。
• 不含/的 pattern 匹配树里任意位置的 basename（*.local.json同时匹配a.local.json 和sub/a.local.json）。
• 含/的 pattern 相对仓库根锚定。
• 结尾的/标记目录 pattern（匹配该目录及其下所有内容）。

不支持：!取反、**双星号。这类情形拆成多条普通 pattern。

create_worktree末尾、git worktree add成功之后，WorktreeManager调用 sync_include_files(source_repo, worktree_path)（openprogram/worktree/include_sync.py）。 这是所有创建路径共同经过的唯一入口——worktree_create工具，以及未来的 task/plan-mode 并发创建——所以钩子挂在 manager 里，不挂在某一个调用方上。

语义：

• 只有未跟踪文件才是候选（git ls-files --others，刻意不加--exclude-standard， 这样已经被 gitignore 的.env之类仍会出现）——已跟踪文件本来就被 git worktree add自己 checkout 了。
• 目标路径已存在就跳过，不覆盖。
• 符号链接按链接本身拷贝，不解引用。
• 文件权限保留（shutil.copy2）。
• 单个文件拷贝失败会被记录，不中断其余文件；成功与失败都会挂到Worktree记录上 （include_synced / include_failed），并回显在worktree_create工具的返回文本里。
• source_repo里没有.worktreeinclude文件→零 git 调用，零行为变化。

Pattern 匹配是手写的 Python（fnmatch + pathlib），不是 git 自己的 exclude 引擎。 git check-ignore / ls-files --exclude-from只会把匹配到的文件从列表里排除—— 没有把 pattern 文件当作包含过滤器的 plumbing 形式——要让 git 指向任意 pattern 文件， 另一条路是core.excludesFile配置注入，这个 sandbox 会拒绝。复用 git 自己枚举未跟踪 文件的能力（git ls-files --others）加一个小的 pattern matcher 处理 manifest， 不需要配置注入也不需要新依赖——pathspec不在openprogram自己的 base dependencies 里，它只通过semble（一个 MCP 开发工具）传递引入。

Part 5. 不在本设计范围#

• 远程 push：worktree 只本地；要把 worktree branch 推 origin，agent 自己用 bash 跑 git push -u origin <branch>。worktree_merge 也不做 push。
• worktree 间 cherry-pick / rebase：复杂语义，留给 agent 自己用 bash 处理。
• 冲突 resolution UI：merge 冲突时 OpenProgram 不提供可视化 mergetool； 让 agent 用 edit 改文件 / bash 跑 git mergetool。
• 跨 source_repo 的 worktree：一个 worktree 必然对应一个 source_repo；不支持 把 worktree 改动 merge 到另一个仓库（要做就用 bash 跑 git patch 流程）。
• discard 前的自动备份：D9 提到的 ~/.openprogram/discarded/ 打包，留作未来加强。
• chroot / namespace 真 sandbox：D6 锁定的是默认 cwd，不是 sandbox；硬隔离走 docker backend。
• session 关闭时自动清理 active worktree：保留 active worktree 跨 session 重启（重启后 list_worktrees 探测，仍 active 的标 kept 让用户手动处理）。

附录：实现状态#

worktree 子系统已经部分实现。当前状态如下：

因此，本设计既不是“完全不存在”，也不能视为全部验收通过。已实现的 manager、持久化、工具、context bridge 和 WebSocket action 应作为当前行为维护；UI chip、完整文件工具边界矩阵、自动取消策略和完整集成测试仍是明确缺口。

以下设计边界不变：远程 push、cherry-pick/rebase、冲突解决 UI、跨仓库 worktree、discard 备份、namespace 隔离，以及 session 关闭后的自动清理。