Claude Code 官方文档地图

按章节整理的官方文档目录与标题树，便于整体浏览。

本页根据官方的 claude_code_docs_map.md 自动整理，方便您按主题系统学习。 如果你想快速开始，建议先看 系统学习路线 和 Desktop / CLI 高频样例。

快速入门

Claude Code 概述

Claude Code 是一种代理编码工具，可以读取您的代码库、编辑文件、运行命令并与您的开发工具集成。可在您的终端、IDE、桌面应用程序和浏览器中使用。

• 开始使用
• 你能做什么
• 到处使用 Claude Code
• 后续步骤

快速入门

欢迎来到Claude Code！

• 开始之前
• 步骤1：安装Claude Code
• 第2步：登录您的帐户
• 第 3 步：开始您的第一个会话
• 第 4 步：提出第一个问题
• 第 5 步：进行第一次代码更改
• 步骤 6：将 Git 与 Claude Code 结合使用
• 第 7 步：修复错误或添加功能
• 第 8 步：测试其他常见工作流程
• 基本命令
• 给初学者的专业提示
• 接下来怎么办？
• 寻求帮助

变更日志

Claude Code 的发行说明，包括按版本划分的新功能、改进和错误修复。

*（未找到标题）

核心概念

Claude Code的工作原理

了解代理循环、内置工具以及 Claude Code 如何与您的交互项目。

• 代理循环
  • 型号
  • 工具
• Claude 可以访问什么
• 环境和接口
  • 执行环境
  • 接口
• 使用会话
  • 跨分支机构工作
  • 恢复或分叉会话
  • 上下文窗口
    • 当上下文填满时
    • 使用技能和子代理管理上下文
• 通过检查点和权限确保安全
  • 通过检查点撤消更改
  • 控制 Claude 可以做什么
• 与 Claude Code 有效配合
  • 向 Claude Code 寻求帮助
  • 这是一次对话
    • 中断和引导
  • 预先具体说明
  • 给 Claude 一些东西来验证
  • 实施前探索
  • 授权，而不是发号施令
• 下一步是什么

扩展 Claude Code

了解何时使用 CLAUDE.md、技能、子代理、挂钩、MCP 和插件。

• 概述
• 将功能与您的目标相匹配
  • 比较相似的功能
  • 了解特征层如何
  • 组合功能
• 了解上下文成本
  • 按功能划分的上下文成本
  • 了解功能如何加载
• 了解更多

Claude 如何记住您的项目

通过 CLAUDE.md 文件赋予 Claude 持久指令，并让 Claude 通过自动记忆自动积累学习内容。

• CLAUDE.md 与自动记忆
• CLAUDE.md 文件
  • 选择放置 CLAUDE.md 文件的位置
  • 建立一个项目CLAUDE.md
  • 编写有效的指令
  • 导入附加文件
  • CLAUDE.md 文件如何加载
    • 从附加目录加载
  • 使用 .claude/rules/ 组织规则
    • 制定规则
    • 特定于路径的规则
    • 使用符号链接在项目之间共享规则
    • 用户级别规则
  • 为大型团队管理 CLAUDE.md
    • 在组织范围内部署 CLAUDE.md
    • 排除特定的 CLAUDE.md 文件
• 自动记忆
  • 启用或禁用自动记忆
  • 存储位置
  • 它是如何运作的
  • 审核和编辑你的记忆
• 使用 /memory 查看和编辑
• 解决内存问题
  • Claude 没有关注我的 CLAUDE.md
  • 我不知道自动记忆保存了什么
  • 我的 CLAUDE.md 太大
  • /compact 之后指令似乎丢失
• 相关资源

常见工作流程

使用 Claude Code 探索代码库、修复错误、重构、测试和其他日常任务的分步指南。* 了解新的代码库

• 快速获取代码库概览
• 查找相关代码
• 高效修复bug
• 重构代码
• 使用专门的子代理
• 使用Plan Mode进行安全代码分析
  • 何时使用 Plan Mode
  • 如何使用Plan Mode
  • 示例：规划复杂的重构
  • 配置Plan Mode为默认
• 进行测试
• 创建拉取请求
• 处理文档
• 处理图像
• 参考文件和目录
• 使用扩展思维（思维模式）
  • 配置思维模式
  • 扩展思维如何发挥作用
• 恢复之前的对话
  • 为您的会话命名
  • 使用会话选择器
• 使用 Git 工作树运行并行 Claude Code 会话
  • 子代理工作树
  • 工作树清理
  • 手动管理工作树
  • 非git版本控制
• 当 Claude 需要您关注时收到通知
• 使用 Claude 作为 UNIX 风格的实用程序
  • 将 Claude 添加到您的验证过程中
  • 管道输入、管道输出
  • 控制输出格式
• 向 Claude 询问其功能
  • 示例问题
• 后续步骤

Claude Code 的最佳实践

充分利用 Claude Code 的提示和模式，从环境配置到工件跨会话进行扩展。

• 给Claude一个验证其工作的方法
• 先探索，然后计划，最后编码
• 在提示中提供具体上下文
  • 提供丰富的内容
• 配置您的环境
  • 写入有效的CLAUDE.md
  • 配置权限
  • 使用CLI工具
  • 连接MCP服务器
  • 设置钩子
  • 创造技能
  • 创建自定义子代理
  • 安装插件
• 有效沟通
  • 询问代码库问题
  • 让 Claude 采访您
• 管理您的会话
  • 尽早且经常纠正航向
  • 积极管理环境
  • 使用子代理进行调查
  • 带检查点的倒带
  • 恢复对话
• 自动化和规模化
  • 运行非交互模式
  • 运行多个 Claude 会话
  • 跨文件扇出
• 避免常见的故障模式
• 发展你的直觉
• 相关资源

平台与集成

桌面端与图形界面

开始使用桌面应用程序

在桌面上安装 Claude Code 并开始您的第一个编码会话

• 安装
• 开始你的第一节课
• 现在怎么办？
• 来自 CLI？
• 下一步是什么

使用 Claude Code 台式机

充分利用Claude Code桌面：具有Git隔离的毛发会话、视线差异审查、应用程序预览、PR监控、权限模式、连接器和企业配置。* 开始一个会话

• 使用代码
  • 使用提示框
  • 添加文件和上下文提示
  • 选择权限模式
  • 预览您的应用程序
  • 使用 diff 视图查看更改
  • 检查您的代码
  • 监控拉取请求状态
• 管理会话
  • 与会议并行工作
  • 远程运行长时间运行的任务
  • 在另一个表面继续
• 扩展Claude Code
  • 连接外部工具
  • 使用技能
  • 安装插件
  • 配置预览服务器
    • 自动验证更改
    • 配置字段
      • 何时使用 program 与 runtimeExecutable
    • 端口冲突
    • 示例
• 安排重复任务
  • 频率选项
  • 计划任务如何运行
  • 错过的跑步
  • 计划任务的权限
  • 管理计划任务
• 环境配置
  • 本地会议
  • 远程会议
  • SSH 会话
• 企业配置
  • 管理控制台控件
  • 托管设置
  • 设备管理策略
  • 身份验证和单点登录
  • 数据处理
  • 部署
• 来自 CLI？
  • CLI 标志等效项
  • 共享配置
  • 功能比较
  • 桌面版中不可用的内容
• 故障排除
  • 检查您的版本
  • 代码选项卡中出现 403 或身份验证错误
  • 启动时出现空白或卡住的屏幕 *“加载会话失败”
  • 会话未找到已安装的工具
  • Git 和 Git LFS 错误
  • MCP 服务器无法在 Windows 上运行
  • 应用程序不会退出
  • Windows 特定问题
  • Cowork 选项卡在 Intel Mac 上不可用
  • 在 CLI 中打开时显示“分支尚不存在”
  • 还卡住了吗？

代码评审与 CI/CD

代码审查

自动PR审查，使用对完整代码库的多代理分析来设置捕获逻辑错误、安全漏洞和返回

• 评论如何运作
  • 严重程度
  • 代码审查检查什么
• 设置代码审查
• 手动触发审核
• 自定义评论
  • CLAUDE.md
  • 审查.md
• 查看使用情况
• 定价
• 相关资源

Claude Code GitHub Actions

了解如何使用 Claude Code 将 Claude Code 集成到您的开发工作流程中

• 为什么使用Claude Code GitHub Actions？
• Claude 能做什么？
  • Claude Code 动作
• 设置
• 快速设置
• 手动设置
• 从测试版升级
  • 重要的改变
  • 重大变更参考
  • 之前和之后的例子
• 示例用例
  • 基本工作流程
  • 使用技巧
  • 带提示的自定义自动化
  • 常见用例
• 最佳实践
  • CLAUDE.md配置
  • 安全考虑
  • 优化性能
  • 持续集成成本
• 配置示例
• 与 AWS Bedrock 和 Google Vertex AI 一起使用
  • 先决条件
    • 对于 Google Cloud Vertex AI：
    • 对于 AWS Bedrock：
• 故障排除
  • Claude 不响应@claude 命令
  • CI 未在 Claude 的提交上运行
  • 验证错误
• 高级配置
  • 动作参数
    • 传递 CLI 参数
  • 替代集成方法
  • 自定义 Claude 的行为

Claude Code GitLab CI/CD

了解如何使用 GitLab CI/CD 将 Claude Code 集成到您的开发工作流程中* 为什么将 Claude Code 与 GitLab 一起使用？

• 它是如何运作的
• Claude 能做什么？
• 设置
  • 快速设置
  • 手动设置（推荐用于生产）
• 示例用例
  • 将问题转化为MR
  • 获取实施帮助
  • 快速修复bug
• 与 AWS Bedrock 和 Google Vertex AI 一起使用
• 配置示例
  • 基本 .gitlab-ci.yml (Claude API)
  • AWS Bedrock 作业示例 (OIDC)
  • Google Vertex AI 作业示例（工作负载身份联合）
• 最佳实践
  • CLAUDE.md配置
  • 安全考虑
  • 优化性能
  • 持续集成成本
• 安全和治理
• 故障排除
  • Claude 不响应@claude 命令
  • Job can’t write comments or open MRs
  • 验证错误
• 高级配置
  • 常用参数和变量
  • 自定义 Claude 的行为

使用 Remote Control 从任何设备继续本地会话

从您的手机、平板电脑或任何浏览器继续使用 Remote Control 本地 Claude Code 会话。可与 claude.ai/code 和 Claude 移动应用程序配合使用。

• 要求
• 启动 Remote Control 会话
  • 从另一台设备连接
  • Enable Remote Control for all sessions
• 连接和安全
• 网络上的 Remote Control 与 Claude Code
• 限制
• 故障排除
• 相关资源

网络上的 Claude Code

在安全的云基础设施上异步运行 Claude Code 任务

• 网络上的 Claude Code 是什么？
• 谁可以在网络上使用 Claude Code？
• 开始使用
• 它是如何运作的
• 使用 diff 视图查看更改
• 在网络和终端之间移动任务
  • 从终端到网络
    • 远程任务提示
  • 从网络到终端
    • 传送的要求
  • 分享会
    • 从企业或团队帐户共享
    • 从 Max 或 Pro 帐户共享
• 管理会话
  • 归档会话
  • 删除会话
• 云环境
  • 默认图片
    • 检查可用工具
    • 特定于语言的设置
    • 数据库
  • 环境配置
  • 设置脚本
    • 设置脚本与 SessionStart 挂钩
  • 依赖管理
    • 保存环境变量
    • 依赖管理限制
• 网络访问和安全
  • 网络政策
    • GitHub 代理
    • 安全代理
  • 访问级别
  • 默认允许的域
    • Anthropic 服务
    • 版本控制
    • 容器注册中心
    • 云平台
    • 包管理器 - JavaScript/Node
    • 包管理器 - Python
    • 包管理器 - Ruby
    • 包管理器 - Rust
    • 包管理器 - Go
    • 包管理器 - JVM
    • 包管理器 - 其他语言
    • Linux 发行版
    • 开发工具和平台
    • 云服务和监控
    • 内容交付和镜像
    • 架构和配置
    • Model Context Protocol
  • 定制网络访问的安全最佳实践
• 安全和隔离
• 定价和费率限制
• 限制
• 最佳实践
• 相关资源

将 Claude Code 与 Chrome（测试版）结合使用

将 Claude Code 连接到 Chrome 浏览器以测试 Web 应用程序、使用控制台日志进行调试、自动填写表单以及从网页中提取数据。* 能力

• 先决条件
• 在 CLI 中开始
  • 默认启用 Chrome
  • 管理站点权限
• 工作流程示例
  • 测试本地网络应用程序
  • 使用控制台日志进行调试
  • 自动填写表格
  • Google 文档中的草稿内容
  • 从网页中提取数据
  • 运行多站点工作流程
  • 录制演示 GIF
• 故障排除
  • 未检测到扩展
  • 浏览器无响应
  • 长时间会话期间连接断开
  • Windows 特定问题
  • 常见错误信息
• 另请参阅

在 VS Code 中使用 Claude Code

安装并配置 VS Code 的 Claude Code 扩展。通过内联差异、@-偏置、计划审查和键盘快捷键获得 AI 编码帮助。

• 先决条件
• 安装扩展
• 开始使用
• 使用提示框
  • 参考文件和文件夹
  • 恢复过去的对话
  • 从 Claude.ai 恢复远程会话
• 定制您的工作流程
  • 选择 Claude 居住的地方
  • 运行多个对话
  • 切换到终端模式
• 管理插件
  • 安装插件
  • 管理市场
• 使用 Chrome 自动执行浏览器任务
• VS Code 命令和快捷键
• 配置设置
  • 扩展设置
• VS Code 扩展与 Claude Code CLI
  • 带检查点的倒带
  • 在 VS Code 中运行 CLI
  • 在扩展和 CLI 之间切换
  • 在提示中包含终端输出
  • 监控后台进程
  • 使用 MCP 连接到外部工具
• 使用git
  • 创建提交和拉取请求
  • 使用 git 工作树进行并行任务
• 使用第三方提供商
• 安全和隐私
• 修复常见问题
  • 扩展不会安装
  • 火花图标不可见
  • Claude Code 从不响应
• 卸载扩展
• 后续步骤

JetBrains IDE

将 Claude Code 与 JetBrains IDE 结合使用，包括 IntelliJ、PyCharm、WebStorm 等

• 支持的 IDE
• 特点
• 安装
  • 市场安装
• 用法
  • 从您的 IDE
  • 从外部终端
• 配置
  • Claude Code 设置
  • 插件设置
    • 常规设置
    • ESC键配置
• 特殊配置
  • 远程开发
  • WSL配置
• 故障排除
  • 插件不工作
  • 未检测到 IDE
  • 未找到命令
• 安全考虑

Claude Code 于 Slack

直接来自 Slack 工作区委派编码任务

• 使用案例
• 先决条件
• 在 Slack 中设置 Claude Code
• 它是如何运作的
  • 自动检测
  • 上下文收集
  • 会话流程
• 用户界面元素
  • 应用程序主页
  • 消息动作
  • 存储库选择
• 访问和权限
  • 用户级访问
  • 工作区级别的访问
  • 基于通道的访问控制
• 在哪里可以访问什么
• 最佳实践
  • 撰写有效的请求
  • 何时使用 Slack 与网络
• 故障排除
  • 会话未开始
  • 存储库未显示
  • 选择了错误的存储库
  • 验证错误
  • 会话过期
• 目前的限制
• 相关资源

构建与扩展

创建自定义子代理

在 Claude Code 中创建和使用专门的 AI 子代理，以实现特定于任务的工作流程并改进上下文管理。* 内置子代理

• 快速入门：创建您的第一个子代理
• 配置子代理
  • 使用/agents命令
  • 选择子代理范围
  • 写入子代理文件
    • 支持的 frontmatter 字段
  • 选择型号
  • 控制子代理能力
    • 可用工具
    • 限制可以生成哪些子代理
    • 将 MCP 服务器范围限定为子代理
    • 权限模式
    • 将技能预加载到子代理中
    • 启用持久内存
      • 持久记忆技巧
    • 带钩子的条件规则
    • 禁用特定的子代理
  • 定义子代理的钩子
    • 子代理 frontmatter 中的挂钩
    • 子代理事件的项目级挂钩
• 与子代理合作
  • 了解自动委派
  • 显式调用子代理
  • 在前台或后台运行子代理
  • 常见模式
    • 隔离大批量操作
    • 进行并行研究
    • 连锁分代理
  • 在副代理和主要对话之间进行选择
  • 管理子代理上下文
    • 恢复子代理
    • 自动压实
• 子代理示例
  • 代码审查员
  • 调试器
  • 数据科学家
  • 数据库查询验证器
• 后续步骤

编排 Claude Code 会话团队

通过共享任务、代理间消息传递和集中管理，协调多个Claude Code实例作为一个团队协同工作。

• 何时使用代理团队
  • 与子代理比较
• 启用代理团队
• 组建你的第一个代理团队
• 控制你的代理团队
  • 选择显示模式
  • 指定队友和模型
  • 需要队友批准计划
  • 直接与队友交谈
  • 分配和领取任务
  • 关闭队友
  • 清理团队
  • 用挂钩加强质量门
• 代理团队如何工作
  • Claude 如何启动代理团队
  • 架构
  • 权限
  • 背景和沟通
  • 代币使用
• 用例示例
  • 运行并行代码审查
  • 用相互竞争的假设进行调查
• 最佳实践
  • 为队友提供足够的背景信息
  • 选择合适的团队规模
  • 适当调整任务大小
  • 等待队友完成
  • 从研究和回顾开始
  • 避免文件冲突
  • 监控和引导
• 故障排除
  • 队友没有出现
  • 权限提示过多
  • 队友因错误而停止
  • 工作完成前，铅会关闭
  • 孤立的 tmux 会话
• 限制
• 后续步骤

创建插件

通过技能、代理、挂钩和 MCP 服务器扩展 Claude Code 创建自定义插件。

• 何时使用插件与独立配置
• 快速入门
  • 先决条件
  • 创建你的第一个插件 *你好技能
  • 插件结构概述
  • 开发更复杂的插件
    • 将技能添加到您的插件中
    • 将 LSP 服务器添加到您的插件中
    • 随您的插件提供默认设置
    • 组织复杂的插件
    • 在本地测试您的插件
    • 调试插件问题
    • 分享您的插件
    • 将您的插件提交到官方市场
  • 将现有配置转换为插件
    • 迁移步骤
    • 迁移时发生了什么变化
  • 后续步骤
    • 对于插件用户
    • 对于插件开发者

通过市场发现并安装预构建的插件

从市场找到并安装插件，以使用新命令、代理和功能扩展 Claude Code。* 市场如何运作

• Anthropic 官方市场
  • 代码智能
    • Claude 从代码智能插件中获得什么
  • 外部集成
  • 开发工作流程
  • 输出样式
• 尝试一下：添加演示市场
• 添加市场
  • 从 GitHub 添加
  • 从其他 Git 主机添加
  • 从本地路径添加
  • 从远程 URL 添加
• 安装插件
• 管理已安装的插件
  • 应用插件更改而无需重新启动
• 管理市场
  • 使用交互界面
  • 使用CLI命令
  • 配置自动更新
• 配置团队市场
• 安全
• 故障排除
  • /插件命令无法识别
  • 常见问题
  • 代码情报问题
• 后续步骤

扩展 Claude 技能

创建、管理和共享技能以扩展 Claude 在 Claude Code 中的功能。包括自定义命令和捆绑技能。

• 捆绑技能
• 开始使用
  • 创建你的第一个技能
  • 技能所在
    • 从嵌套目录中自动发现
    • 来自附加目录的技能
• 配置技能
  • 技能内容类型
  • 前言参考
    • 可用的字符串替换
  • 添加支持文件
  • 控制谁调用技能
  • 限制工具访问
  • 将参数传递给技能
• 高级模式
  • 注入动态上下文
  • 在子代理中运行技能
    • 示例：使用 Explore 代理研究技能
  • 限制Claude的技能访问
• 分享技能
  • 生成视觉输出
• 故障排除
  • 技能不触发
  • 技能触发过于频繁
  • Claude 看不到我所有的技能
• 相关资源

按计划运行提示

使用 /loop 和 cron 调度工具在 Claude Code 会话中重复运行提示、轮询状态或设置间歇提醒。

• 使用 /loop 安排重复提示
  • 区间语法
  • 循环另一个命令
• 设置一次性提醒
• 管理计划任务
• 计划任务如何运行
  • 抖动
  • 三天有效期
• Cron表达式参考
• 禁用计划任务
• 限制

输出样式

使 Claude Code 适应软件工程以外的用途

• 内置输出样式
• 输出样式如何工作
• 改变你的输出风格
• 创建自定义输出样式
  • 前言
• 相关功能比较
  • 输出样式 vs. CLAUDE.md vs. —append-system-prompt
  • 输出样式与代理
  • 输出风格与技能

使用钩子自动化工作流程

当Claude Code编辑文件、完成任务或需要输入时自动运行shell命令。删除代码、发送通知、验证命令并执行项目规则。

• 设置你的第一个钩子
• 你可以自动化什么
  • 当 Claude 需要输入时收到通知
  • 编辑后自动格式化代码
  • 阻止对受保护文件的编辑
  • 压缩后重新注入上下文
  • 审计配置变更
  • 自动批准特定权限提示
• 钩子是如何工作的
  • 读取输入并返回输出
    • 钩子输入
    • 挂钩输出
    • 结构化JSON输出
  • 带匹配器的过滤钩
  • 配置钩子位置
• 基于提示的钩子
• 基于代理的钩子
• HTTP 钩子
• 限制和故障排除
  • 限制
  • 钩子不发射
  • 输出中的钩子错误
  • /hooks 显示未配置挂钩
  • 停止钩子永远运行
  • JSON 验证失败
  • 调试技巧
• 了解更多

以编程方式运行 Claude Code使用 Agent SDK 通过 CLI、Python 或 TypeScript 以编程方式运行 Claude Code。

• 基本用法
• 示例
  • 获取结构化输出
  • 流响应
  • 自动批准工具
  • 创建提交
  • 自定义系统提示
  • 继续对话
• 后续步骤

通过 MCP 将 Claude Code 连接到工具

了解如何使用 Model Context Protocol 将 Claude Code 连接到您的工具。

• MCP 可以做什么
• 流行的 MCP 服务器
• 安装 MCP 服务器
  • 选项 1：添加远程 HTTP 服务器
  • 选项2：添加远程SSE服务器
  • 选项 3：添加本地 stdio 服务器
  • 管理您的服务器
  • 动态工具更新
  • 提供插件的MCP服务器
• MCP安装范围
  • 本地范围
  • 项目范围
  • 用户范围
  • 选择合适的范围
  • 范围层次结构和优先级
  • .mcp.json 中的环境变量扩展
• 实际例子
  • 示例：使用 Sentry 监控错误
  • 示例：连接到 GitHub 进行代码审查
  • 示例：查询您的 PostgreSQL 数据库
• 使用远程 MCP 服务器进行身份验证
  • 使用固定的OAuth回调端口
  • 使用预配置的 OAuth 凭据
  • 覆盖 OAuth 元数据发现
• 从 JSON 配置中添加 MCP 服务器
• 从 Claude Desktop 导入 MCP 服务器
• 使用 Claude.ai 的 MCP 服务器
• 使用 Claude Code 作为 MCP 服务器
• MCP 输出限制和警告
• 响应 MCP 启发请求
• 使用MCP资源
  • 参考MCP资源
• 使用 MCP 工具搜索进行缩放
  • 它是如何运作的
  • 对于 MCP 服务器作者
  • 配置工具搜索
• 使用MCP提示符作为命令
  • 执行MCP提示
• 托管 MCP 配置
  • 选项 1：使用 Managed-mcp.json 进行独占控制
  • 选项 2：基于策略的控制，包括允许列表和拒绝列表
    • 限制选项
    • 配置示例
    • 基于命令的限制如何工作
    • 基于 URL 的限制如何工作
    • 允许列表行为 (allowedMcpServers)
    • 拒绝名单行为 (deniedMcpServers)
    • 重要提示

故障排除

查找 Claude Code 安装和使用常见问题的解决方案。* 解决安装问题

• 调试安装问题
  • 检查网络连接
  • 验证您的路径
  • 检查安装冲突
  • 检查目录权限
  • 验证二进制文件是否有效
• 常见安装问题
  • 安装脚本返回 HTML 而不是 shell 脚本
  • 安装后command not found: claude
  • curl: (56) Failure writing output to destination
  • TLS 或 SSL 连接错误
  • Failed to fetch version from storage.googleapis.com
  • Windows：无法识别 irm 或 &&
  • 在低内存 Linux 服务器上安装被杀死
  • 安装在 Docker 中挂起
  • Windows：Claude Desktop 覆盖 claude CLI 命令
  • Windows：“Windows 上的 Claude Code 需要 git-bash”
  • Linux：安装了错误的二进制变体（musl/glibc 不匹配）
  • Illegal instruction 于 Linux
  • dyld: cannot load 于 macOS
  • Windows 安装问题：WSL 中的错误
  • WSL2 沙箱设置
  • 安装过程中权限错误
• 权限和认证
  • 重复权限提示
  • 身份验证问题
  • OAuth 错误：无效代码
  • 403 登录后禁止
  • 有效订阅的“该组织已被禁用”
  • OAuth 在 WSL2 中登录失败 *“未登录”或令牌已过期
• 配置文件位置
  • 重置配置
• 性能稳定
  • CPU或内存使用率高
  • 命令挂起或冻结
  • 搜索和发现问题
  • WSL 上的搜索结果缓慢或不完整
• IDE集成问题
  • WSL2 上未检测到 JetBrains IDE
    • WSL2网络模式
  • 报告 Windows IDE 集成问题
  • 退出键在 JetBrains IDE 终端中不起作用
• Markdown 格式问题
  • 代码块中缺少语言标签
  • 间距和格式不一致
  • 减少 Markdown 格式问题
• 获得更多帮助

部署

企业部署概述

了解 Claude Code 如何与各种第三方服务和基础设施集成满足企业部署要求。

• 比较部署选项
• 配置代理和网关
  • Amazon Bedrock
  • Microsoft Foundry
  • Google Vertex AI
• 组织的最佳实践
  • 投资于文档和内存
  • 简化部署
  • 从指导使用开始
  • 云提供商的引脚模型版本
  • 配置安全策略
  • 利用 MCP 进行集成
• 后续步骤

Claude Code 上 Amazon Bedrock

了解如何通过 Amazon Bedrock 配置 Claude Code，包括设置、IAM 配置和故障修复。

• 先决条件
• 设置
  • 1.提交用例详细信息
  • 2.配置AWS凭证
    • 高级凭证配置
      • 配置示例
      • 配置设置说明
  • 3.配置Claude Code
  • 4. 引脚型号版本
    • 将每个模型版本映射到推理配置文件
• IAM配置
• AWS 护栏
• 故障排除
• 额外资源

Claude Code 上 Google Vertex AI

了解如何通过 Google Vertex AI 配置 Claude Code，包括设置、IAM 配置和故障修复。

• 先决条件
• 区域配置
• 设置
  • 1.启用Vertex AI API
  • 2.请求模型访问
  • 3.配置GCP凭证
  • 4.配置Claude Code
  • 5. 引脚型号版本
• IAM配置
• 1M 令牌上下文窗口
• 故障排除
• 额外资源

Claude Code 上 Microsoft Foundry了解如何通过 Microsoft Foundry 配置 Claude Code，包括设置、配置和故障修复。

• 先决条件
• 设置
  • 1.提供Microsoft Foundry资源
  • 2.配置Azure凭据
  • 3.配置Claude Code
  • 4. 引脚型号版本
• Azure RBAC 配置
• 故障排除
• 额外资源

企业网络配置

使用代理服务器、自定义证书颁发机构（CA）和交互传输层安全（mTLS）身份验证为企业环境配置Claude Code。

• 代理配置
  • 环境变量
  • 基本身份验证
• 自定义CA证书
• mTLS认证
• 网络访问要求
• 额外资源

LLM 网关配置

了解如何配置 Claude Code 与 LLM 网关解决方案配合使用。涵盖网关要求、身份验证配置、模型选择和特定于成功的端点设置。

• 网关要求
• 配置
  • 型号选择
• LiteLLM配置
  • 先决条件
  • LiteLLM 基本设置
    • 认证方式
      • 静态API密钥
      • 带助手的动态 API 密钥
    • 统一端点（推荐）
    • 特定于提供商的传递端点（替代）
      • Claude API 通过 LiteLLM
      • Amazon Bedrock 通过 LiteLLM
      • Google Vertex AI 通过 LiteLLM
• 额外资源

开发容器

了解适合需要一致、安全环境的团队的 Claude Code 开发容器。

• 主要特点
• 4步入门
• 配置细目
• 安全功能
• 定制选项
• 示例用例
  • 保护客户工作
  • 团队入职
  • 一致的 CI/CD 环境
• 相关资源

管理

高级设置

Claude Code 的系统要求、特定于平台的安装、版本管理和卸载。

• 系统要求
  • 额外的依赖项
• 安装Claude Code
  • 在 Windows 上设置
  • Alpine Linux 和基于 musl 的发行版
• 验证您的安装
• 验证
• 更新Claude Code
  • 自动更新
  • 配置发布通道
  • 禁用自动更新
  • 手动更新
• 高级安装选项
  • 安装特定版本
  • 已弃用 npm 安装
    • 从npm迁移到native
    • 使用npm安装
  • 二进制完整性和代码签名
• 卸载Claude Code
  • 原生安装
  • Homebrew安装
  • WinGet安装
  • npm
  • 删除配置文件

验证

登录 Claude Code 并配置个人、团队和组织的身份验证。

• 登录Claude Code
• 设置团队认证
  • Claude 适用于团队或企业
  • Claude 控制台认证
  • 云提供商身份验证
• 凭证管理
  • 认证优先级

安全

了解Claude Code的安全保障措施和安全使用的最佳实践。

• 我们如何处理安全问题
  • 安全基础
  • 基于权限的架构
  • 内置保护
  • 用户责任
• 防止即时注入
  • 核心保护
  • 隐私保护
  • 额外的保障措施
• MCP 安全
• IDE安全性
• 云执行安全
• 安全最佳实践
  • 使用敏感代码
  • 团队安全
  • 报告安全问题
• 相关资源

服务器管理的设置（公开配置测试版）

通过服务器为您的组织集中配置Claude Code提供的设置，消耗设备管理基础设施。* 要求

• 在服务器管理和端点管理设置之间进行选择
• 配置服务器管理的设置
  • 验证设置交付
  • 访问控制
  • 目前的限制
• 设置传送
  • 设置优先级
  • 获取和缓存行为
  • 安全批准对话框
• 平台可用性
• 审计日志记录
• 安全考虑
• 另请参阅

数据使用情况

了解 Anthropic 的 Claude 数据使用政策

• 数据政策
  • 数据训练政策
  • 开发合作伙伴计划
  • 使用 /bug 命令进行反馈
  • 会议质量调查
  • 数据保留
• 数据访问
• 本地Claude Code：数据流和依赖关系
  • 云执行：数据流和依赖关系
• 遥测服务
• API 提供商的默认行为

零数据保留

了解 Claude for Enterprise 上 Claude Code 的零数据保留 (ZDR)，包括范围、取消的功能以及如何请求启用。

• ZDR 范围
  • ZDR 涵盖的内容
  • ZDR 不涵盖的内容
• ZDR 下禁用的功能
• 违反政策的数据保留
• 请求ZDR

监控

了解如何为 Claude Code 启用和配置 OpenTelemetry。

• 快速启动
• 管理员配置
• 配置详细信息
  • 常用配置变量
  • Metrics基数控制
  • 动态标题
    • 设置配置
    • 脚本要求
    • 刷新行为
  • 多团队组织支持
  • 配置示例
• 可用指标和事件
  • 标准属性
  • 指标
  • 指标详细信息
    • 会话计数器
    • 代码行数计数器
    • 拉取请求计数器
    • 提交计数器
    • 成本计数器
    • 令牌计数器
    • 代码编辑工具决策计数器
    • 活动时间计数器
  • 活动
    • 事件关联属性
    • 用户提示事件
    • 工具结果事件
    • API请求事件
    • API错误事件
    • 工具决策事件
• 解释指标和事件数据
  • 使用情况监控
  • 成本监控
  • 警报和分段
  • 事件分析
• 后端注意事项
  • 对于指标
  • 对于事件/日志
• 服务信息
• 投资回报率衡量资源
• 安全和隐私
• 在 Amazon Bedrock 上监控 Claude Code

有效管理成本

通过上下文管理、模型选择、扩展思维设置和断挂钩，跟踪代币使用情况、设置团队支出限制并降低Claude Code成本。

• 跟踪您的成本
  • 使用/cost命令
• 管理团队成本
  • 速率限制建议
  • 代理团队代币成本
• 减少代币使用
  • 主动管理环境
  • 选择合适的型号
  • 减少 MCP 服务器开销
  • 安装类型化语言的代码智能插件
  • 将处理卸载到钩子和技能
  • 将指令从 CLAUDE.md 移至技能
  • 调整延伸思维
  • 将详细操作委托给子代理
  • 管理代理团队成本
  • 写出具体的提示
  • 高效地处理复杂的任务
• 后台代币使用
• 了解 Claude Code 行为的变化

通过分析跟踪团队使用情况

在分析仪表板中查看Claude Code使用指标、跟踪采用情况并缩短工程速度。* 访问团队和企业的分析

• 启用贡献指标
• 查看摘要指标
• 探索图表
  • 跟踪采用情况
  • 衡量每个用户的 PR
  • 查看拉取请求细分
  • 查找杰出贡献者
• 公关归因
  • 标记标准
  • 归因过程
  • 时间窗口
  • 排除的文件
  • 归属说明
• 充分利用分析
  • 监控采用情况
  • 衡量投资回报率
  • 识别高级用户
  • 以编程方式访问数据
• 访问 API 客户分析
  • 查看团队见解
• 相关资源

创建和分发插件市场

以跨团队和社区分发 Claude Code 扩展构建和托管插件市场。

• 概述
• 演练：创建本地市场
• 创建市场文件
• 市场架构
  • 必填字段
  • 所有者字段
  • 可选元数据
• 插件条目
  • 必填字段
  • 可选插件字段
• 插件来源
  • 相对路径
  • GitHub 存储库
  • Git 存储库
  • Git 子目录
  • npm 包
  • 高级插件条目
  • 严格模式
• 托管和分发市场
  • GitHub 上的主机（推荐）
  • 托管在其他 git 服务上
  • 私有存储库
  • 分发前在本地测试
  • 需要为您的团队提供市场
  • 预填充容器插件
  • 受管理的市场限制
    • 常用配置
    • 限制如何运作
  • 版本解析及发布渠道
    • 设置发布渠道
      • 示例
      • 将频道分配给用户组
• 验证和测试
• 故障排除
  • 市场未加载
  • 市场验证错误
  • 插件安装失败
  • 私有仓库认证失败
  • Git操作超时
  • 具有相对路径的插件在基于 URL 的市场中失败
  • 安装后找不到文件
• 另请参阅

配置

Claude Code 设置

使用全局和项目级设置以及环境指标配置 Claude Code。

• 配置范围
  • 可用范围
  • 何时使用每个范围
  • 范围如何交互
  • 范围的用途
• 设置文件
  • 可用设置
  • 全局配置设置
  • 工作树设置
  • 权限设置
  • 权限规则语法
  • 沙盒设置
    • 沙箱路径前缀
  • 归因设置
  • 文件建议设置
  • 挂钩配置
  • 设置优先级
  • 验证活动设置
  • 配置系统要点
  • 系统提示
  • 排除敏感文件
• 子代理配置
• 插件配置
  • 插件设置
    • enabledPlugins
    • extraKnownMarketplaces
    • strictKnownMarketplaces
  • 管理插件
• 环境变量
• Claude 可用的工具
• 另请参阅

配置权限

使用细粒度的权限规则、模式和托管策略控制 Claude Code 可以访问和执行的操作。* 权限系统

• 管理权限
• 权限模式
• 权限规则语法
  • 匹配工具的所有用途
  • 使用说明符进行细粒度控制
  • 通配符模式
• 工具特定的权限规则
  • Bash
  • 阅读和编辑
  • 网页抓取
  • MCP
  • 代理（子代理）
• 通过hook扩展权限
• 工作目录
• 权限如何与沙箱交互
• 托管设置
  • 仅限托管设置
• 设置优先级
• 配置示例
• 另请参阅

沙盒

了解 Claude Code 的沙盒 bash 工具如何提供文件系统和网络隔离，以实现更安全、更自治的代理执行。

• 概述
• 为什么沙箱很重要
• 它是如何运作的
  • 文件系统隔离
  • 网络隔离
  • 操作系统级强制执行
• 开始使用
  • 先决条件
  • 启用沙箱
  • 沙盒模式
  • 配置沙箱
    • 授予子进程对特定路径的写权限
• 安全优势
  • 防止即时注入
  • 减少攻击面
  • 透明操作
• 安全限制
• 沙箱与权限的关系
• 高级用法
  • 自定义代理配置
  • 与现有安全工具集成
• 最佳实践
• 开源
• 限制
• 另请参阅

优化您的终端设置

当您的配置正确时，Claude Code 效果最佳。请遵循这些指南来优化您的体验。

• 主题和外观
• 换行符
• 通知设置
  • 终端通知
  • 通知挂钩
• 处理大量输入
• Vim模式

模型配置

了解 Claude Code 模型配置，包括 opusplan 等模型别名

• 可用模型
  • 模型别名
  • 设置您的模型
• 限制模型选择
  • 默认模型行为
  • 控制用户运行的模型
  • 合并行为
• 特殊模型行为
  • default型号设置
  • opusplan型号设置
  • 调整努力程度
  • 扩展上下文
• 检查您当前的型号
• 环境变量
  • 第三方部署的引脚模型
  • 覆盖每个版本的模型 ID
  • 提示缓存配置

使用快速模式加速响应速度

通过切换快速模式，在 Claude Code 中获得更快的 Opus 4.6 响应。

• 切换快速模式
• 了解成本权衡
• 决定何时使用快速模式
  • 快速模式与努力水平
• 要求
  • 为您的组织启用快速模式
  • 需要每个会话选择加入
• 处理速率限制
• 研究预览
• 另请参阅

语音听写

使用一键通语音听写出提示，而不是在 Claude Code CLI 中键入提示。

• 要求
• 启用语音听写
• 录制提示
• 更改听写语言
• 重新绑定一键通键
• 故障排除
• 另请参阅

自定义您的状态行

配置自定义状态栏以监控 Claude Code 中的上下文窗口使用情况、成本和 git 状态

• 设置状态行
  • 使用/statusline命令
  • 手动配置状态行
  • 禁用状态栏
• 逐步构建状态行
• 状态线如何工作
• 可用数据
  • 上下文窗口字段
• 示例
  • 上下文窗口的使用
  • 带颜色的 Git 状态
  • 成本和持续时间跟踪
  • 显示多行
  • 可点击的链接
  • 缓存昂贵的操作
  • Windows配置
• 提示
• 故障排除

自定义键盘快捷键

使用按键绑定配置文件自定义 Claude Code 中的键盘快捷键。* 配置文件

• 上下文
• 可用的操作
  • 应用程序操作
  • 历史动作
  • 聊天动作
  • 自动完成动作
  • 确认动作
  • 权限操作
  • 记录行动
  • 历史搜索动作
  • 任务动作
  • 主题动作
  • 帮助动作
  • 选项卡操作
  • 附件操作
  • 页脚动作
  • 消息选择器动作
  • 差异动作
  • 模型选择器动作
  • 选择动作
  • 插件操作
  • 设置动作
  • 语音动作
• 按键语法
  • 修饰符
  • 大写字母
  • 和弦
  • 特殊按键
• 解除默认快捷键绑定
• 预留快捷键
• 终端冲突
• Vim模式交互
• 验证

参考

CLI 参考

Claude Code命令行界面的完整参考，包括命令和标志。

• CLI命令
• CLI 标志
  • 系统提示标志
• 另请参阅

内置命令

Claude Code 中提供内置命令的完整参考。

• MCP提示
• 另请参阅

环境变量

控制 Claude Code 行为环境变量的完整参考。

• 另请参阅

工具参考

Claude Code 可以完整参考使用该工具，包括权限要求。

• Bash 工具行为
• 另请参阅

交互模式

Claude Code 会话中键盘快捷键、输入模式和交互功能的完整参考。

• 键盘快捷键
  • 一般控制
  • 文本编辑
  • 主题和显示
  • 多行输入
  • 快速命令
  • 语音输入
• 内置命令
• Vim编辑器模式
  • 模式切换
  • 导航（正常模式）
  • 编辑（普通模式）
  • 文本对象（正常模式）
• 命令历史记录
  • 使用 Ctrl+R 反向搜索
• 后台 bash 命令
  • 背景如何工作
  • 带有 ! 前缀的 Bash 模式
• 提示建议
• 附带问题 /btw
• 任务列表
• PR审核状态
• 另请参阅

检查点

跟踪、倒带和总结 Claude 的编辑和对话以管理会话状态。

• 检查点如何运作
  • 自动跟踪
  • 倒带并总结
    • 恢复与总结
• 常见用例
• 限制
  • 未跟踪 Bash 命令更改
  • 未跟踪外部更改
  • 不能替代版本控制
• 另请参阅

挂钩参考

Claude Code 挂钩事件、配置架构、JSON 输入/输出格式、退出代码、牵引挂钩、HTTP 挂钩、提示挂钩和 MCP 工具挂钩的参考。* 钩子生命周期

• 钩子如何解析
• 配置
  • 挂钩位置
  • 匹配器模式
    • 匹配MCP工具
  • 钩子处理程序字段
    • 常用字段
    • 命令挂钩字段
    • HTTP 挂钩字段
    • 提示和代理挂钩字段
  • 按路径引用脚本
  • 技能和特工的挂钩
  • /hooks 菜单
  • 禁用或删除钩子
• 钩子输入输出
  • 常用输入框
  • 退出代码输出
    • 每个事件的退出代码 2 行为
  • HTTP响应处理
  • JSON输出
    • 决策控制
• 挂钩事件
  • 会话开始
    • 会话开始输入
    • SessionStart决策控制
    • 保存环境变量
  • 说明已加载
    • 说明加载输入
    • 指令加载决策控制
  • 用户提示提交
    • 用户提示提交输入
    • UserPromptSubmit决策控制
  • 预工具使用
    • PreToolUse输入
      • Bash
      • 写
      • 编辑
      • 阅读
      • 全局
      • 格列普
      • 网页抓取
      • 网络搜索
      • 代理
    • PreToolUse决策控制
  • 权限请求
    • 权限请求输入
    • PermissionRequest决策控制
    • 权限更新条目
  • 后置工具使用
    • PostTool使用输入
    • PostToolUse决策控制
  • 工具使用失败后
    • PostToolUseFailure输入
    • PostToolUseFailure决策控制
  • 通知
    • 通知输入
  • 子代理启动
    • 子代理启动输入
  • 子代理停止
    • 子代理停止输入
  • 停止
    • 停止输入
    • 停止决策控制
  • 队友空闲
    • 队友空闲输入
    • 队友空闲决策控制
  • 任务完成
    • 任务完成输入
    • 任务完成决策控制
  • 配置更改
    • 配置更改输入
    • ConfigChange决策控制
  • 工作树创建
    • 工作树创建输入
    • 工作树创建输出
  • 工作树删除
    • 工作树删除输入
  • 预压缩
    • 预压缩输入
  • 后紧凑
    • 后压缩输入
  • 会话结束
    • 会话结束输入
  • 引出
    • 引出输入
    • 引出输出
  • 启发结果
    • 引出结果输入
    • 引出结果输出
• 基于提示的钩子
  • 基于提示的钩子如何工作
  • 提示钩子配置
  • 响应模式
  • 示例：多标准停止钩
• 基于代理的钩子
  • 代理钩子如何工作
  • 代理钩子配置
• 在后台运行钩子
  • 配置异步钩子
  • 异步钩子如何执行
  • 示例：文件更改后运行测试
  • 限制
• 安全考虑
  • 免责声明
  • 安全最佳实践
• 调试钩子

插件参考

Claude Code 插件系统的完整技术参考，包括架构、CLI 命令和规范组件。* 插件组件参考

• 技能
• 代理
• 挂钩
• MCP 服务器
• LSP服务器
• 插件安装范围
• 插件清单架构
  • 完整的架构
  • 必填字段
  • 元数据字段
  • 组件路径字段
  • 路径行为规则
  • 环境变量
    • 持久化数据目录
• 插件缓存和文件解析
  • 路径遍历限制
  • 使用外部依赖项
• 插件目录结构
  • 标准插件布局
  • 文件位置参考
• CLI 命令参考
  • 插件安装
  • 插件卸载
  • 插件启用
  • 插件禁用
  • 插件更新
• 调试和开发工具
  • 调试命令
  • 常见问题
  • 错误消息示例
  • 钩子故障排除
  • MCP服务器故障排除
  • 目录结构错误
• 发行版和版本控制参考
  • 版本管理
• 另请参阅

资源

法律与合规

Claude Code 的法律协议、合规性认证和安全信息。

• 法律协议
  • 许可证
  • 商业协议
• 合规性
  • 医疗保健合规性 (BAA)
• 使用政策
  • 可接受的用途
  • 身份验证和凭证使用
• 安全与信任
  • 信任和安全
  • 安全漏洞报告