Files
claude-code/docs/auto-updater.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

12 KiB
Raw Permalink Blame History

自动更新机制

概述

Claude Code 拥有一套复杂的多策略自动更新系统,支持三种安装方式、后台静默更新、手动 CLI 命令、服务端版本门控以及更新日志展示。系统设计目标是在最小用户干预下保持 CLI 最新,同时提供回滚和手动控制的兜底手段。


安装类型与更新策略

更新策略由安装方式决定,通过 src/utils/doctorDiagnostic.ts 检测:

安装类型 更新策略 自动安装?
native 从 GCS/Artifactory 下载二进制文件,通过符号链接激活 是(静默)
npm-global npm install -g / bun install -g 是(静默)
npm-local npm install~/.claude/local/ 是(静默)
package-manager 显示通知,附带对应操作系统的升级命令 否(仅通知)
development 不适用 — 执行 claude update 时报错 不适用

策略路由

src/components/AutoUpdaterWrapper.tsx — 挂载在 React/Ink UI 树中 — 检测安装类型并渲染对应的更新组件:

  • nativeNativeAutoUpdater(二进制下载 + 符号链接)
  • package-managerPackageManagerAutoUpdater(仅通知)
  • 其他 → AutoUpdater(基于 JS/npm

后台自动更新循环

三个更新组件共享相同的轮询模式:

useInterval(checkForUpdates, 30 * 60 * 1000); // 每 30 分钟

组件挂载时(即启动时)也会执行一次检查。

前置检查门控

任何更新尝试之前,系统会依次检查:

  1. 自动更新是否被禁用?getAutoUpdaterDisabledReason()src/utils/config.ts:1737
    • NODE_ENV === 'development'
    • 设置了 DISABLE_AUTOUPDATER 环境变量
    • 仅限必要流量模式
    • config.autoUpdates === falsenative 安装的保护模式除外)
  2. 最大版本上限?getMaxVersion()src/utils/autoUpdater.ts:108)— 服务端熔断开关,防止更新到已知有问题的版本
  3. 是否跳过该版本?shouldSkipVersion()src/utils/autoUpdater.ts:145)— 尊重用户的 minimumVersion 设置,防止切换到 stable 频道时发生意外的版本降级

Native 自动更新器(src/components/NativeAutoUpdater.tsx

  1. 调用 src/utils/nativeInstaller/installer.ts 中的 installLatest()
  2. 通过 src/utils/nativeInstaller/download.ts 下载二进制文件GCS 或 Artifactory
  3. 验证 SHA256 校验和3 次重试60 秒卡顿检测)
  4. 将版本化二进制文件存储到 XDG 目录
  5. 更新符号链接(~/.local/bin/claude → 新版本二进制文件)
  6. 保留最近 2 个版本,清理旧版本
  7. 将错误分类上报分析超时、校验和、权限、磁盘空间不足、npm、网络

JS/npm 自动更新器(src/components/AutoUpdater.tsx

  1. 调用 getLatestVersion() 获取当前 npm dist-tag
  2. 通过 semver gte() 比较版本
  3. 根据安装类型路由到本地或全局安装
  4. 使用文件锁(acquireLock() / releaseLock())防止并发更新

包管理器通知器(src/components/PackageManagerAutoUpdater.tsx

每 30 分钟通过 GCS 存储桶(非 npm检查更新。不会自动安装 — 仅显示对应操作系统的升级命令:

  • macOS: brew upgrade claude-code
  • Windows: winget upgrade Anthropic.ClaudeCode
  • Alpine: apk upgrade claude-code

启动版本门控

src/utils/autoUpdater.ts:70assertMinVersion()

定义于 src/utils/autoUpdater.ts:70,设计上在启动时调用(当前未接入启动流程):

void assertMinVersion();
  1. 从 GrowthBook 动态配置获取 tengu_version_config
  2. 如果 MACRO.VERSION < minVersion,打印错误信息并调用 gracefulShutdownSync(1) — 强制用户更新
  3. 这是一个硬性门控 — 低于最低版本的 CLI 将无法启动

手动 CLI 命令

claude update / claude upgrade

文件: src/cli/update.ts

完整流程:

  1. 运行 getDoctorDiagnostic() 检查系统健康状态
  2. 检查是否存在多个安装及配置不一致
  3. 根据安装类型路由:
    • development → 报错("开发版本不支持自动更新"
    • package-manager → 打印对应操作系统的更新命令
    • native → 使用原生安装器的 updateLatest()
    • npm-local → 在 ~/.claude/local/ 执行 npm install
    • npm-global → 执行 npm install -g(含权限检查)
  4. 报告当前版本、最新版本、成功/失败状态

claude rollback [target](仅限内部)

回滚到之前的版本。支持 --list--dry-run--safe 标志。

claude install [target]

安装或重新安装原生构建版本。接受可选的版本目标参数。

claude doctor

检查自动更新器的健康状态,报告状态、权限和配置信息。


原生安装器架构

文件: src/utils/nativeInstaller/installer.ts

二进制文件存储布局

~/.local/share/claude-code/
├── versions/          # 版本化二进制文件 (claude-1.0.3, claude-1.0.4, ...)
├── staging/           # 临时下载暂存区
└── locks/             # 基于 PID 和 mtime 的锁文件

~/.local/bin/claude    # 指向当前版本二进制文件的符号链接

Windows 系统使用文件复制而非符号链接。

核心操作

函数 说明
updateLatest() 核心更新流程:最大版本上限 → 跳过检查 → 加锁 → 下载 → 安装 → 更新符号链接
installLatest() Singleflight 包装版本,防止重复的进行中安装
cleanupOldVersions() 保留最近 2 个版本,清理过期的暂存区和临时文件
lockCurrentVersion() 进程生命周期锁,防止正在运行的版本被删除
cleanupNpmInstallations() 迁移到原生安装时清理旧的 npm 安装

下载与校验

文件: src/utils/nativeInstaller/download.ts

  1. 路由到 Artifactory内部用户或 GCS 存储桶(外部用户)
  2. 下载二进制文件并跟踪进度
  3. SHA256 校验和验证
  4. 60 秒卡顿检测(中止停滞的下载)
  5. 失败时自动重试 3 次

文件锁机制

文件: src/utils/autoUpdater.ts:176-268

防止并发更新进程破坏安装:

  • 锁文件:~/.claude/update.lock(或等效路径)
  • 5 分钟超时 — 超过 5 分钟的锁被视为过期,强制获取
  • 进程将其 PID 写入锁文件
  • acquireLock()releaseLock() 同时被 JS/npm 和原生安装器使用

配置

设置项

文件: src/utils/settings/types.ts

设置项 类型 说明
autoUpdatesChannel 'latest' | 'stable' 自动更新的发布频道
minimumVersion string 最低版本要求,防止意外的版本降级

全局配置

文件: src/utils/config.ts:191-193

字段 类型 说明
autoUpdates boolean 启用/禁用自动更新(旧版)
autoUpdatesProtectedForNative boolean 原生安装始终自动更新

配置迁移

文件: src/migrations/migrateAutoUpdatesToSettings.ts

一次性将旧版 globalConfig.autoUpdates = false 迁移为 settings 中的 DISABLE_AUTOUPDATER=1 环境变量。定义于 src/migrations/migrateAutoUpdatesToSettings.ts(当前未接入启动流程)。


更新通知去重

文件: src/hooks/useUpdateNotification.ts

React hook useUpdateNotification(updatedVersion) — 确保每次 semver 变更major.minor.patch只显示一次"重启以更新"消息,避免同一版本的重复通知。


更新日志

文件: src/utils/releaseNotes.ts

  1. src/setup.ts:387 在每次启动时调用
  2. 从 GitHub 获取 changelog
  3. 缓存到 ~/.claude/cache/changelog.md
  4. 展示比 lastReleaseNotesSeen 更新的版本的更新日志
  5. 使用 semver 比较确定需要展示哪些日志

版本比较

文件: src/utils/semver.ts

  • 提供 gt()gte()lt()lte()satisfies()order()
  • 在 Bun 环境下使用 Bun.semver.order()(快 20 倍)
  • 在 Node.js 环境下回退到 npm semver

分析事件

所有更新相关的遥测数据使用 tengu_ 前缀的事件:

类别 事件
版本检查 tengu_version_check_successtengu_version_check_failure
JS 自动更新器 tengu_auto_updater_start/success/fail/up_to_date/lock_contention
原生自动更新器 tengu_native_auto_updater_start/success/fail
原生更新 tengu_native_update_complete/skipped_max_version/skipped_minimum_version
锁机制 tengu_version_lock_acquired/failedtengu_native_update_lock_failed
二进制下载 tengu_binary_download_attempt/success/failuretengu_binary_manifest_fetch_failure
清理 tengu_native_version_cleanuptengu_native_staging_cleanuptengu_native_stale_locks_cleanup
安装 tengu_native_install_package_success/failuretengu_native_install_binary_success/failure
手动更新 tengu_update_check
迁移 tengu_migrate_autoupdates_to_settingstengu_migrate_autoupdates_error

关键文件索引

文件 职责
src/utils/autoUpdater.ts 核心逻辑版本检查、npm 安装、文件锁、最低/最高版本门控
src/cli/update.ts claude update 命令处理
src/utils/nativeInstaller/installer.ts 原生二进制安装器:下载、版本管理、符号链接、清理
src/utils/nativeInstaller/download.ts 从 GCS/Artifactory 下载二进制文件并校验
src/utils/localInstaller.ts 本地安装器(~/.claude/local/)基于 npm
src/components/AutoUpdaterWrapper.tsx 基于安装类型的策略路由
src/components/AutoUpdater.tsx JS/npm 后台自动更新器30 分钟间隔)
src/components/NativeAutoUpdater.tsx 原生二进制后台自动更新器30 分钟间隔)
src/components/PackageManagerAutoUpdater.tsx 包管理器通知30 分钟,仅展示)
src/hooks/useUpdateNotification.ts 按 semver 去重更新通知
src/utils/releaseNotes.ts Changelog 获取、缓存与展示
src/utils/semver.ts Semver 版本比较Bun 原生 + npm 回退)
src/utils/doctorDiagnostic.ts 安装类型检测与健康诊断
src/utils/config.ts:1737 getAutoUpdaterDisabledReason() — 禁用检查逻辑
src/migrations/migrateAutoUpdatesToSettings.ts 旧版配置迁移
src/screens/Doctor.tsx Doctor 命令 UI展示自动更新状态

流程图

启动阶段
  ├── assertMinVersion() → 版本过低时硬性拦截,拒绝启动
  ├── migrateAutoUpdatesToSettings() → 一次性配置迁移
  └── checkForReleaseNotes() → 展示新版本的更新日志

REPL 运行中(每 30 分钟)
  ├── AutoUpdaterWrapper 检测安装类型
  │
  ├── native → NativeAutoUpdater
  │     ├── 从 GCS/Artifactory 获取版本
  │     ├── 检查最大版本上限(服务端控制)
  │     ├── 检查 minimumVersion 设置(跳过)
  │     ├── acquireLock()
  │     ├── downloadAndVerifyBinary()SHA256 校验3 次重试)
  │     ├── 安装到 versions/ 目录
  │     ├── 更新符号链接
  │     └── cleanupOldVersions()(保留 2 个版本)
  │
  ├── npm-global/local → AutoUpdater
  │     ├── 从 npm registry 获取最新版本
  │     ├── semver 版本比较
  │     ├── acquireLock()
  │     └── npm install -g / 本地安装
  │
  └── package-manager → PackageManagerAutoUpdater
        ├── 从 GCS 获取版本
        └── 显示 "Run: brew upgrade ..."(不自动安装)

手动操作
  └── claude update → 完整诊断 + 安装编排