Files
claude-code/docs/features/stub-recovery-design-1-4.md
claude-code-best c5edee431f docs: 文档检查/check 20260419 (#296)
* 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>
2026-04-19 09:30:00 +08:00

9.8 KiB
Raw Blame History

Stub 恢复设计 1-4

日期2026-04-12 目标:基于当前代码边界,为下一阶段 4 个 stub/半 stub 命令面给出可实施的设计方案。 排序原则:按建议实施顺序排序,不按问题严重性排序。

设计原则

  • 先做能独立闭环、收益明确、改动边界清晰的项。
  • 大项拆成 MVPPhase 2+,避免一次性掉进大范围恢复。
  • 优先复用已有状态、传输层、日志与配置能力,不重造协议。
  • 设计以当前仓库实际代码为准,不以旧文档的理想状态为准。

1. claude daemon status / claude daemon stop

现状

  • start 路径已有完整 supervisor + worker 生命周期: src/daemon/main.ts src/daemon/workerRegistry.ts
  • status / stop 目前只是占位输出: src/daemon/main.ts
  • /remote-control-server 有自己的命令内 UI 状态,但只维护当前进程内的 daemonProcess,并不适合作为跨进程 CLI 管理基础: src/commands/remoteControlServer/remoteControlServer.tsx

目标

  • claude daemon statusclaude daemon stop 在另一个 CLI 进程中也能正确工作。
  • 不依赖 TUI 内存态,不要求当前命令进程就是启动 daemon 的那个进程。

MVP 方案

  • 新增 daemon 状态文件,例如: ~/.claude/daemon/remote-control.json
  • start 时写入:
    • supervisor pid
    • cwd
    • startedAt
    • worker kinds
    • 最近状态
  • status
    • 读取状态文件
    • 用现有进程探测能力验证 pid 是否存活
    • 输出 running / stopped / stale
    • stale 时自动清理状态文件
  • stop
    • 读取 pid
    • 发送 SIGTERM
    • 等待退出
    • 超时后 SIGKILL
    • 清理状态文件

代码范围

  • 新增 src/daemon/state.ts
  • 修改 src/daemon/main.ts
  • 轻量修改 src/commands/remoteControlServer/remoteControlServer.tsx,让 UI 尽量读取同一份状态文件

验证

  1. claude daemon start
  2. 新开终端执行 claude daemon status
  3. 执行 claude daemon stop
  4. 再次执行 claude daemon status,确认返回 stopped 或清晰的 stale cleaned

风险

  • Windows 信号模型和 Unix 不同,stop 需要超时兜底。
  • 当前设计默认单 supervisor不处理多实例并发。

工作量判断

  • 适合作为下一步的首选实现项

2. BG_SESSIONS

现状

  • fast-path 已接好: src/entrypoints/cli.tsx
  • session registry 已有真实实现: src/utils/concurrentSessions.ts
  • exit 在 bg session 内已会 tmux detach-client src/commands/exit/exit.tsx
  • 但 CLI handler 仍全空: src/cli/bg.ts
  • task summary 仍然是 stub src/utils/taskSummary.ts

目标

  • 先把 ps / logs / kill 做成真正有用的 session 管理命令。
  • 不在第一阶段就强行补完 attach / --bg

Phase 2AMVP

  • 实现 ps
    • 从 registry 读取 live sessions
    • 展示 pid、kind、sessionId、cwd、name、startedAt、bridgeSessionId
    • 如果有 activity/status则一并展示
  • 实现 logs
    • 支持按 sessionId / pid / name 查找
    • 优先复用本地 transcript/log 读取能力
    • 如果 registry 里存在 logPath,支持 tail 文件
  • 实现 kill
    • 解析目标 session
    • 发退出信号
    • 清理 stale registry

Phase 2B后续

  • 实现 attach
  • 实现 --bg
  • 实现 taskSummary 的中途状态更新

为什么要拆

  • 现有 registry 记录了 pid / sessionId / name / logPath
  • 但没有可靠的 tmux attach target
  • 所以 attach--bg 不是简单补 handler而是需要补启动/附着元数据设计

代码范围

  • 修改 src/cli/bg.ts
  • 修改 src/utils/concurrentSessions.ts 以便后续 attach/--bg 扩展
  • 修改 src/utils/taskSummary.ts
  • 复用: src/utils/sessionStorage.ts src/utils/udsClient.ts

验证

  1. ps 能列出 live sessions
  2. logs <sessionId|pid|name> 能输出对应日志
  3. kill <sessionId|pid|name> 能结束目标 session

风险

  • attach / --bg 第二阶段需要 tmux 元数据设计
  • Windows 下 tmux 路径需要明确降级策略

工作量判断

  • ps/logs/kill 中等
  • attach/--bg 明显更大,应分阶段

3. TEMPLATES

现状

  • 命令入口只有 fast-path src/entrypoints/cli.tsx
  • handler 是空的: src/cli/handlers/templateJobs.ts
  • markdownConfigLoader 已把 templates 纳入配置目录: src/utils/markdownConfigLoader.ts
  • query / stopHooks 已预留 job classifier 链路: src/query/stopHooks.ts
  • jobs/classifier.ts 仍是 stub src/jobs/classifier.ts

目标

  • new / list / reply 做成可用的模板任务系统。
  • 第一阶段不碰复杂的自动分类与自动执行。

MVP 方案

  • 模板来源: .claude/templates/*.md
  • 模板格式: 复用现有 markdown + frontmatter 解析,不另外设计 DSL
  • list
    • 列出所有模板
    • 显示模板名、description、路径
  • new <template> [args...]
    • 解析模板
    • ~/.claude/jobs/<job-id>/ 下创建 job 目录
    • 写入 template.mdinput.txtstate.json
    • 返回 job id 与目录
  • reply <job-id> <text>
    • 将回复写入 replies.jsonlinput.txt
    • 更新 state.json

Phase 2

  • 恢复 src/jobs/classifier.ts
  • 让带 CLAUDE_JOB_DIR 的 job session 在 turn 完成后自动更新 state.json
  • 再决定是否补自动 job runner

为什么要拆

  • 当前证据表明这是“template job commands”不是单纯模板列表
  • 但自动 job 运行链路没有足够现成实现,先做文件系统 job lifecycle 更稳

代码范围

验证

  1. list 能列出 .claude/templates
  2. new 能创建 job 目录和状态文件
  3. reply 能更新 job 内容和状态
  4. Phase 2 再验证 classifier 写状态

风险

  • frontmatter schema 需要先定义最小字段集
  • 一旦扩展到“自动运行 job”范围会明显膨胀

工作量判断

  • MVP 中等
  • 完整 job 系统偏大

4. assistant [sessionId]

现状

目标

  • 不一次性恢复整个 KAIROS 助手系统。
  • 先做“明确 sessionId 的 viewer attach 可用”,再逐步补 discovery / chooser / install。

Phase 4AMVP

  • 只支持 claude assistant <sessionId>
  • claude assistant 无参数模式,先返回明确提示:
    • 当前版本需要显式 sessionId
    • discovery 尚未启用
  • 这样可以直接复用现有 attach 分支,不必先恢复 chooser/install wizard

Phase 4B

  • 恢复 discoverAssistantSessions()
  • 数据来源优先复用现有 sessions / bridge / teleport API而不是新协议
  • claude assistant 无参数时能拿到候选 session 列表

Phase 4C

  • 恢复 AssistantSessionChooser
  • 多 session 时可交互选择

Phase 4D

  • 最后考虑 install wizard 辅助函数
  • 这部分属于“没有 session 时如何引导”,不是 attach 核心路径

为什么要拆

  • attach 渲染层与远端消息通道大部分已经在
  • 真正缺的是“如何发现目标 session”和“如何交互选择”
  • 如果把 src/assistant/index.ts 的整套 KAIROS 正常模式也一起拉进来,范围会失控

代码范围

验证

  1. claude assistant <sessionId> 能进入 remote viewer
  2. 历史懒加载工作正常
  3. 无参数模式先给出明确提示
  4. 后续阶段再分别验证 discovery / chooser / install

风险

  • 这是四项里范围最大的
  • 一旦把 KAIROS 正常模式整体拉入会从“viewer attach”膨胀成“完整 assistant mode 恢复”

工作量判断

  • Phase 4A 中等
  • 4A-4D 全做完很大

建议执行顺序

  1. claude daemon status / claude daemon stop
  2. BG_SESSIONS 先做 ps/logs/kill
  3. TEMPLATES 先做 job 文件系统 MVP
  4. assistant [sessionId] 先做显式 sessionId attach再补 discovery/chooser/install

简短结论

这四项里,最适合立刻实现的是 daemon status/stopBG_SESSIONSTEMPLATES 适合按 MVP 先补 handler 与文件系统闭环。assistant [sessionId] 不能整块硬上应该按“attach → discovery → chooser → install”拆开恢复。