Claude Code 官方文档
中文完整镜像
按 Anthropic 官方文档逐页整理的中文版, 从入门概念到 Agent SDK API 参考,114 篇文档分 16 大类。 每篇都标注源 URL,方便对照原版。
官方权威
Anthropic 文档中文版
✅ 看完这一栏目,你会
关于本栏目
本栏目是对 Anthropic Claude Code 官方文档(code.claude.com/docs/zh-CN)的中文版镜像 + 本地化整理。每篇文章都在顶部标注源 URL,遇到不一致以官方为准。
当前覆盖 114 篇,分为 16 大类,包括基础入门、配置、权限、扩展机制、平台集成、云与企业部署、CI/CD、参考文档、最佳实践,以及完整的 Agent SDK Python / TypeScript API 参考。
少数 zh-CN 没翻译的页面已回落 en/ 版本并标注「(原文为英文,已翻译)」。本站不是 Anthropic 出品,与官方无关联。
文档目录
共 16 大类 · 114 篇文档第 1 部分
入门
Claude Code 是什么、5 种界面、安装、第一次会话、运行原理
第 1 部分:入门 5 篇
Claude Code 是一个 AI 驱动的代理式编码工具,可以读取代码库、编辑文件、运行命令,并跨终端、IDE、桌面应用和浏览器协作开发。
几分钟内上手 Claude Code,完成首次安装、登录、首个会话以及常见的代码探索、修改、Git 与调试任务。
深入理解 Claude Code 的代理循环、模型与内置工具、上下文窗口与会话管理,以及检查点与权限两大安全机制。
Claude Code 的系统要求、各平台安装方式、Windows 与 Alpine 等特殊环境配置、版本管理、二进制完整性验证以及完整卸载流程。
修复安装或登录 Claude Code 时出现的命令未找到、PATH、权限、网络和身份验证错误。
第 2 部分
身份与组织
登录、组织部署、跨账户切换
第 3 部分
配置
settings.json、环境变量、.claude 目录、终端、字体、模型、状态栏
第 3 部分:配置 10 篇
使用全局和项目级设置以及环境变量配置 Claude Code。
控制 Claude Code 行为的环境变量完整参考。
Claude Code 读取 CLAUDE.md、settings.json、hooks、skills、commands、subagents、rules 和自动内存的位置。
使用快捷键配置文件在 Claude Code 中自定义快捷键。
修复 Shift+Enter 换行、获取终端铃声、配置 tmux、匹配颜色主题,以及在 Claude Code CLI 中启用 Vim 模式。
配置自定义状态栏以监控 Claude Code 中的上下文窗口使用情况、成本和 git 状态。
将 Claude Code 适配用于软件工程之外的用途。
了解 Claude Code 模型配置,包括模型别名如 opusplan。
告诉自动模式分类器您的组织信任哪些代码库、存储桶和域。设置环境上下文、覆盖默认规则并使用 CLI 子命令检查配置。
通过 Claude.ai 上基于网络的界面为您的组织集中配置 Claude Code,无需设备管理基础设施。
第 4 部分
权限与安全
权限模式、细粒度权限、安全模型、沙箱化、合规与零数据保留
第 4 部分:权限与安全 6 篇
控制 Claude 在编辑文件或运行命令前是否询问。在 CLI 中使用 Shift+Tab 循环切换模式。
通过细粒度权限规则、模式和托管策略来控制 Claude Code 可以访问和执行的操作。
了解 Claude Code 的安全防护措施和安全使用的最佳实践。
了解 Claude Code 的沙箱 bash 工具如何提供文件系统和网络隔离,以实现更安全、更自主的代理执行。
Claude Code 的法律协议、合规认证、使用政策与安全信息。
了解 Claude for Enterprise 上 Claude Code 的零数据保留(ZDR),包括范围、禁用功能以及如何请求启用。
第 5 部分
扩展核心机制
CLAUDE.md 内存、Skills、MCP、子代理、代理团队、扩展概览
第 5 部分:扩展核心机制 6 篇
了解何时使用 CLAUDE.md、Skills、subagents、hooks、MCP 和 plugins——选择正确的扩展层来满足你的工作流需求。
通过 CLAUDE.md 文件给 Claude 提供持久化指令,配合自动记忆机制让 Claude 在会话间累积学习与项目知识。
通过创建 SKILL.md 文件给 Claude 注入可重复使用的工作流、领域知识与命令,理解触发机制、frontmatter 字段以及在 subagent 中运行的高级模式。
使用 Model Context Protocol 把 GitHub、Sentry、数据库、Notion 等外部工具接入 Claude Code,包含安装、范围、OAuth 认证、托管配置与工具搜索。
用专门的 subagents 处理隔离任务,节省主对话上下文,限定工具与权限,并跨项目复用配置;含内置代理、frontmatter 字段和分叉模式。
协调多个 Claude Code 实例作为一个团队一起工作,具有共享任务、代理间消息传递和集中管理。
第 6 部分
插件
插件创建、市场、依赖管理、参考文档
第 6 部分:插件 5 篇
创建自定义插件以使用 skills、agents、hooks 和 MCP servers 扩展 Claude Code——支持在项目和团队中共享。
Claude Code 插件系统的完整技术参考,包括组件架构、CLI 命令、插件清单架构、目录结构和开发工具。
通过市场发现和安装预构建插件,使用新 skills、agents 和功能扩展 Claude Code。
构建和托管 plugin marketplace,以在团队和社区中分发 Claude Code 扩展——支持 GitHub、Git URL、本地路径和远程 URL。
在插件依赖上声明版本约束,以便当上游插件发布破坏性变更时,你的插件继续正常工作。
第 7 部分
Hooks 与自动化
Hooks 工作流、Routines、定时任务、Channels 事件推送
第 7 部分:Hooks 与自动化 6 篇
在 Claude Code 编辑文件、完成任务或需要输入时自动运行 shell 命令,用 Hooks 格式化代码、发送通知、验证命令并强制执行项目规则。
Claude Code hook 事件、配置架构、JSON 输入/输出格式、退出代码、异步 hooks、HTTP hooks、提示 hooks 和 MCP 工具 hooks 的完整参考。
让 Claude Code 自动运行——定义在 Anthropic 云上按计划运行、通过 API 调用触发或对 GitHub 事件做出反应的例程。
用 /loop 和 cron 调度工具在 Claude Code 会话中重复运行提示词、轮询状态或设置一次性提醒。
使用 Channels 从 MCP 服务器把消息、警报和 webhook 推送到运行中的 Claude Code 会话——转发 CI 结果、聊天消息和监控事件让 Claude 在你离开时做出反应。
构建一个 MCP 服务器,把 webhook、警报和聊天消息推送到 Claude Code 会话——频道契约的参考:能力声明、通知事件、回复工具、发送者门控和权限中继。
第 8 部分
状态与上下文
Checkpointing 回滚机制、Context Window 管理
第 9 部分
成本与分析
费用控制、团队使用分析、数据使用政策
第 9 部分:成本与分析 3 篇
跟踪 token 使用情况、设置团队支出限制,并通过上下文管理、模型选择、扩展思考设置和预处理 hooks 来降低 Claude Code 成本。
在分析仪表板中查看 Claude Code 使用指标、跟踪采用情况,并衡量工程速度——通过 GitHub 集成跟踪贡献指标和排行榜。
了解 Anthropic 对 Claude 数据使用的政策——数据训练、保留、反馈、会话调查和远程 Claude Code 的数据流。
第 10 部分
平台与界面
VS Code / JetBrains / 桌面 / Web / Chrome / Slack / 远程控制 / Computer Use
第 10 部分:平台与界面 12 篇
选择在哪里运行 Claude Code 以及连接什么工具。比较 CLI、Desktop、VS Code、JetBrains、Web 以及 Chrome、Slack 和 CI/CD 等集成。
安装和配置 VS Code 的 Claude Code 扩展。获得 AI 编码协助,包括内联差异、@-提及、计划审查和快捷键。
在 JetBrains IDE(包括 IntelliJ、PyCharm、WebStorm 等)中使用 Claude Code 的安装、配置与故障排除。
充分利用 Claude Code Desktop:并行会话、拖放窗格布局、集成终端、文件编辑器、可视化 diff 审查、应用预览、PR 监控、连接器和企业配置。
在桌面上安装 Claude Code 并开始您的第一个编码会话,了解会话、权限模式和差异审查的基础。
在 Claude Code Desktop 中设置计划任务,让 Claude 自动定期运行:每日代码审查、依赖审计或晨间简报。
配置云环境、设置脚本、网络访问和 Docker,在 Anthropic 的沙箱中运行。使用 --remote 和 --teleport 在网络和终端之间移动会话。
从浏览器或手机在云中运行 Claude Code。连接 GitHub 仓库、提交任务,并在无需本地设置的情况下审查 PR。
将 Claude Code 连接到 Chrome 浏览器,以测试网络应用、使用控制台日志进行调试、自动填充表单以及从网页中提取数据。
直接从 Slack 工作区委派编码任务。@提及 Claude,自动检测意图并在网络上创建 Claude Code 会话。
使用 Remote Control 从您的手机、平板电脑或任何浏览器继续本地 Claude Code 会话。适用于 claude.ai/code 和 Claude 移动应用。
在 Claude Code CLI 中启用 computer use,使 Claude 能够在 macOS 上打开应用、点击、输入和查看您的屏幕。
第 11 部分
云与企业部署
Bedrock / Vertex AI / Foundry / GitHub Enterprise / 网络配置 / LLM 网关 / OpenTelemetry
第 11 部分:云与企业部署 8 篇
通过 Amazon Bedrock 配置 Claude Code,包括登录向导、IAM 配置、模型固定、Mantle 端点和故障排除。
通过 Google Vertex AI 配置 Claude Code,包括登录向导、区域端点、IAM 配置、模型固定和故障排除。
通过 Microsoft Foundry 配置 Claude Code,包括 Azure 凭证、模型部署、RBAC 配置和故障排除。
将 Claude Code 连接到自托管 GitHub Enterprise Server 实例,启用 Web 会话、代码审查和插件市场。
了解 Claude Code 如何与 Anthropic、AWS Bedrock、GCP Vertex AI 和 Microsoft Foundry 等平台集成的企业部署选项。
为企业环境配置 Claude Code,支持代理服务器、自定义 CA 证书、mTLS 身份验证和网络访问要求。
配置 Claude Code 通过 LLM 网关代理,实现集中身份验证、使用情况跟踪、成本控制和模型路由。
通过 OpenTelemetry 导出指标、事件和分布式跟踪,跨组织跟踪 Claude Code 使用情况、成本和工具活动。
第 12 部分
CI/CD 与代码审查
GitHub Actions、GitLab CI/CD、自动 PR 审查
第 12 部分:CI/CD 与代码审查 3 篇
通过在 PR 或 issue 中提及 @claude,让 Claude 自动分析代码、创建 PR、实现功能和修复错误。
在 GitLab CI/CD 管道中集成 Claude Code,从问题创建 MR、自动化实现并支持 Bedrock/Vertex 等企业提供商。
设置自动化 PR 审查,通过对完整代码库的多代理分析来捕获逻辑错误、安全漏洞和回归问题。
第 13 部分
高级功能
Headless 编程化、Dev Container、交互模式、Fast Mode、语音、深链、Ultraplan、Ultrareview
第 13 部分:高级功能 9 篇
使用 Agent SDK 从 CLI、Python 或 TypeScript 以编程方式运行 Claude Code,适用于 CI/CD、脚本和自动化场景。
在开发容器中运行 Claude Code,为团队提供一致、隔离的环境,包括身份验证持久化、组织策略强制和网络出站限制。
Claude Code 会话中键盘快捷键、Vim 编辑器模式、命令历史、后台任务和会话回顾的完整参考。
通过切换快速模式获得 2.5 倍更快的 Claude Opus 4.6 响应,适用于交互式工作和实时调试场景。
启用更流畅、无闪烁的渲染模式,支持鼠标操作,在长对话中保持稳定的内存使用。
在 Claude Code CLI 中使用按住录音或点击录音的语音听写功能来说出你的提示词,转录后插入到输入框中。
通过 claude-cli:// 深链接从 URL 打开 Claude Code 终端会话,可在运行手册、警报、仪表板或 README 中嵌入。
使用 ultraplan 在云端的 Claude Code 网络版会话中草拟计划,然后远程执行或在本地终端中执行复杂更改。
使用 /ultrareview 在云中运行深度多代理代码审查,在合并前查找和验证错误。
第 14 部分
参考与故障排除
CLI 参考、工具参考、命令、术语表、错误码、配置调试、故障排除
第 14 部分:参考与故障排除 7 篇
Claude Code 命令行界面的完整参考,包含所有子命令与命令行标志,从启动会话、恢复对话到 MCP、subagents 与系统提示等所有 CLI 选项。
Claude Code 可以使用的所有工具的完整参考,包括 Bash、Edit、LSP、Monitor、PowerShell 等及其权限要求。
Claude Code 中所有内置命令和捆绑 skills 的完整参考,从 /clear、/compact、/model 到 /diff、/review、/teleport 等。
Claude Code 核心术语定义,包括 agentic loop、compaction、CLAUDE.md、hooks、subagents、MCP 等概念。
查找 Claude Code 运行时错误消息,了解每个错误的含义以及如何修复,包括 API 错误、使用限制、身份验证、网络和请求错误。
诊断 CLAUDE.md、settings、hooks、MCP 服务器或 skills 没有生效的原因,使用 /context、/doctor、/hooks 和 /mcp 检查实际加载内容。
修复 Claude Code 中的高 CPU 或内存使用、挂起、自动压缩抖动和搜索问题,并找到其他问题的正确页面。
第 15 部分
最佳实践与工作流
Anthropic 推荐的最佳实践与常见工作流模式
第 16 部分
Agent SDK
Python / TypeScript SDK 完整参考:构建生产级 AI Agent
第 16 部分:Agent SDK 28 篇
使用 Claude Code 作为库构建生产级 AI 代理。Agent SDK 提供与 Claude Code 相同的工具、代理循环和上下文管理,支持 Python 和 TypeScript。
使用 Python 或 TypeScript Agent SDK 在几分钟内构建一个能够查找并修复代码错误的 AI 代理。
了解 SDK 代理的消息生命周期、工具执行、上下文窗口和支持架构。
将项目说明、skills、hooks 和其他 Claude Code 功能加载到您的 SDK 代理中。
使用 Claude Agent SDK 的进程内 MCP 服务器定义自定义工具,让 Claude 调用你的函数、访问 API 并执行特定领域的操作。
配置 MCP 服务器以扩展代理的外部工具,涵盖传输类型、大型工具集的工具搜索、身份验证和错误处理。
在代理执行的关键点使用 hooks 拦截和自定义代理行为,包括阻止危险操作、记录审计、转换输入输出等。
使用权限模式、hooks 和声明式允许/拒绝规则来控制您的代理如何使用工具。
通过 Agent SDK 加载自定义 plugins,使用命令、agents、skills 和 hooks 扩展 Claude Code。
使用 Claude Agent SDK 中的 Agent Skills 扩展 Claude 的专业能力。
学习如何通过 SDK 使用 slash commands 来控制 Claude Code 会话,包括 /compact、/context 和自定义命令。
在 Claude Agent SDK 应用程序中定义和调用子代理以隔离上下文、并行运行任务,并应用专门的指令。
启用部分消息流式传输,从 Agent SDK 获取文本和工具调用的实时增量更新。
了解 Claude Agent SDK 的两种输入模式及何时使用每种模式。(原文为英文,已翻译)
使用 JSON Schema、Zod 或 Pydantic 从代理工作流返回经过验证的 JSON,在多轮工具使用后获得类型安全的结构化数据。(原文为英文,已翻译)
了解会话如何保持代理对话历史,以及何时使用 continue、resume 和 fork 返回到之前的运行。
了解如何跟踪令牌使用情况、估计成本,以及使用 Claude Agent SDK 配置提示缓存。
在代理会话期间跟踪文件更改并将文件恢复到任何先前状态。(原文为英文,已翻译)
向用户显示 Claude 的批准请求和澄清问题,然后将他们的决定返回给 SDK。
使用 Claude Agent SDK 跟踪和显示待办事项,实现有组织的任务管理。
通过按需发现和加载工具,将代理扩展到数千个工具。(原文为英文,已翻译)
学习如何使用三种方法自定义 Claude 的行为:输出样式、带 append 的 systemPrompt 和自定义系统提示。(原文为英文,已翻译)
使用 OpenTelemetry 将跟踪、指标和事件从 Agent SDK 导出到你的可观测性后端。(原文为英文,已翻译)
在生产环境中部署和托管 Claude Agent SDK。
通过隔离、凭证管理和网络控制保护 Claude Code 和 Agent SDK 部署的指南。(原文为英文,已翻译)
将 Claude Code TypeScript 和 Python SDK 迁移到 Claude Agent SDK 的指南。
Python Agent SDK 的完整 API 参考,包括所有函数、类型和类。
TypeScript Agent SDK 的完整 API 参考,包括所有函数、类型和接口。
快速跳转
关于内容时效
- ✓ 翻译自 code.claude.com 官方文档
- ✓ 每篇标注源 URL 方便对照
- ✓ 如遇过时以官方原版为准
- ✓ 本站非 Anthropic 出品