Claude Code:代理式编码的最佳实践
原文:Claude Code: Best practices for agentic coding
日期:2025.04.18
Claude Code 是一个用于代理式编码的命令行工具。本文涵盖了在各种代码库、语言和环境中使用 Claude Code 已被证明有效的技巧和窍门。
我们最近发布了 Claude Code,一个用于代理式编码的命令行工具。作为研究项目开发的 Claude Code,为 Anthropic 的工程师和研究人员提供了一种更原生的方式,将 Claude 集成到他们的编码工作流中。
Claude Code 刻意设计得低层级且不固执己见,提供近乎原始的模型访问,而不强迫特定的工作流。这种设计哲学创造了一个灵活、可定制、可编写脚本且功能强大的安全工具。尽管功能强大,但这种灵活性对于刚接触代理式编码工具的工程师来说,会有一个学习曲线——至少在他们形成自己的最佳实践之前是这样。
本文概述了一些已被证明有效的通用模式,这些模式对 Anthropic 内部团队和在各种代码库、语言和环境中外部使用 Claude Code 的工程师都很有用。此列表中的任何内容都不是一成不变的,也不是普遍适用的;请将这些建议视为起点。我们鼓励您进行实验,找到最适合您的方法!
寻找更详细的信息?我们在 claude.ai/code 的综合文档涵盖了本文提到的所有功能,并提供了额外的示例、实现细节和高级技术。
1. 自定义您的设置
Claude Code 是一个代理式编码助手,它会自动将上下文拉取到提示中。这种上下文收集会消耗时间和 token,但您可以通过环境调整来优化它。
a. 创建 CLAUDE.md 文件
CLAUDE.md 是一个特殊文件,Claude 在开始对话时会自动将其拉入上下文。这使其成为记录以下内容的理想场所:
- 常见的 bash 命令
- 核心文件和实用函数
- 代码风格指南
- 测试说明
- 仓库礼仪(例如,分支命名、merge vs. rebase 等)
- 开发者环境设置(例如,pyenv 的使用、哪些编译器可用)
- 项目特有的任何意外行为或警告
- 您希望 Claude 记住的其他信息
CLAUDE.md 文件没有必需的格式。我们建议保持其简洁易读。例如:
1 | # Bash 命令 |
您可以将 CLAUDE.md 文件放置在几个位置:
- 您的仓库根目录,或您运行
claude的任何地方(最常见用法)。将其命名为CLAUDE.md并提交到 git 中,以便您可以在会话之间以及与团队共享(推荐),或者将其命名为CLAUDE.local.md并将其添加到.gitignore中。 - 您运行
claude的目录的任何父目录。这对于 monorepos 最有用,您可能在root/foo中运行claude,并在 root/CLAUDE.md 和 root/foo/CLAUDE.md 中都有CLAUDE.md文件。这两个文件都将被自动拉入上下文。 - 您运行
claude的目录的任何子目录。这与上述情况相反,在这种情况下,当您处理子目录中的文件时,Claude 会按需拉入 CLAUDE.md 文件。 - 您的主文件夹 (
~/.claude/CLAUDE.md),它将应用于您所有的 claude 会话。
当您运行 /init 命令时,Claude 会自动为您生成一个 CLAUDE.md。
b. 调整您的 CLAUDE.md 文件
您的 CLAUDE.md 文件会成为 Claude 提示的一部分,因此应像任何经常使用的提示一样进行优化。一个常见的错误是添加大量内容而不迭代其有效性。花时间进行实验,确定什么能让模型产生最佳的指令遵循效果。
您可以手动向 CLAUDE.md 添加内容,或按 # 键给 Claude 一个指令,它会自动将其合并到相关的 CLAUDE.md 中。许多工程师在编码时频繁使用 # 来记录命令、文件和风格指南,然后将 CLAUDE.md 的更改包含在提交中,以便团队成员也能受益。
在 Anthropic,我们偶尔会用提示改进器处理 CLAUDE.md 文件,并经常调整指令(例如,用 “IMPORTANT” 或 “YOU MUST” 来强调)以提高遵循度。

c. 管理 Claude 的允许工具列表
默认情况下,Claude Code 会对任何可能修改您系统的操作请求许可:文件写入、许多 bash 命令、MCP 工具等。我们以这种刻意保守的方法设计 Claude Code,以优先考虑安全性。您可以自定义允许列表,以允许您知道是安全的其他工具,或者允许那些容易撤销的潜在不安全工具(例如,文件编辑、git commit)。
有四种方法可以管理允许的工具:
- 在会话期间,当出现提示时选择“始终允许”。
- 启动 Claude Code 后,使用
/permissions命令从允许列表中添加或删除工具。例如,您可以添加Edit来始终允许文件编辑,Bash(git commit:*)来允许 git 提交,或mcp__puppeteer__puppeteer_navigate来允许使用 Puppeteer MCP 服务器进行导航。 - 手动编辑您的
.claude/settings.json或~/.claude.json(我们建议将前者检入源代码控制以与您的团队共享)。 - 使用
--allowedToolsCLI 标志进行会话特定的权限设置。
d. 如果使用 GitHub,请安装 gh CLI
Claude 知道如何使用 gh CLI 与 GitHub 交互,以创建 issue、打开拉取请求、阅读评论等。如果没有安装 gh,Claude 仍然可以使用 GitHub API 或 MCP 服务器(如果您已安装)。
2. 给予 Claude 更多工具
Claude 可以访问您的 shell 环境,您可以在其中为它构建一系列便利的脚本和函数,就像为自己构建一样。它还可以通过 MCP 和 REST API 利用更复杂的工具。
a. 将 Claude 与 bash 工具结合使用
Claude Code 继承了您的 bash 环境,使其可以访问您所有的工具。虽然 Claude 知道像 unix 工具和 gh 这样的常用工具,但如果没有指令,它不会知道您的自定义 bash 工具:
- 告诉 Claude 工具名称和使用示例
- 告诉 Claude 运行 –help 来查看工具文档
- 在 CLAUDE.md 中记录常用工具
b. 将 Claude 与 MCP 结合使用
Claude Code 同时作为 MCP 服务器和客户端。作为客户端,它可以通过三种方式连接到任意数量的 MCP 服务器以访问其工具:
- 在项目配置中(在那个目录中运行 Claude Code 时可用)
- 在全局配置中(在所有项目中可用)
- 在已检入的
.mcp.json文件中(对在您的代码库中工作的任何人可用)。例如,您可以将 Puppeteer 和 Sentry 服务器添加到您的.mcp.json中,这样在您的仓库上工作的每位工程师都可以开箱即用地使用这些工具。
在使用 MCP 时,使用 --mcp-debug 标志启动 Claude 以帮助识别配置问题也可能很有帮助。
c. 使用自定义斜杠命令
对于重复的工作流程——调试循环、日志分析等——将提示模板存储在 .claude/commands 文件夹中的 Markdown 文件中。当您输入 / 时,这些命令将通过斜杠命令菜单可用。您可以将这些命令检入 git,使其对您的团队其他成员可用。
自定义斜杠命令可以包含特殊关键字 $ARGUMENTS,以从命令调用中传递参数。
例如,这是一个可以用来自动拉取和修复 Github issue 的斜杠命令:
1 | Please analyze and fix the GitHub issue: $ARGUMENTS. |
将以上内容放入 .claude/commands/fix-github-issue.md 中,使其在 Claude Code 中作为 /project:fix-github-issue 命令可用。然后您可以使用例如 /project:fix-github-issue 1234 来让 Claude 修复 issue #1234。同样,您可以将自己的个人命令添加到 ~/.claude/commands 文件夹中,以便在所有会话中使用。
3. 尝试常见的工作流程
Claude Code 不强加特定的工作流程,让您可以灵活地按自己想要的方式使用它。在这种灵活性提供的空间内,我们的用户社区中涌现出了几种有效使用 Claude Code 的成功模式:
a. 探索(Explore)、计划(plan)、编码(code)、提交(commit)
这个多功能的工作流程适用于许多问题:
要求 Claude 阅读相关文件、图片或 URL,可以提供一般性指引(“阅读处理日志的文件”)或特定文件名(“阅读 logging.py”),但明确告诉它暂时不要编写任何代码。
- 这是工作流程中您应该考虑强力使用子代理的部分,特别是对于复杂问题。告诉 Claude 使用子代理来验证细节或调查它可能有的特定问题,尤其是在对话或任务的早期,往往可以在不损失太多效率的情况下保留上下文的可用性。
要求 Claude 制定一个解决特定问题的计划。我们建议使用“思考(think)”一词来触发扩展思考模式,这会给 Claude 额外的计算时间来更彻底地评估备选方案。这些特定的短语直接映射到系统中递增的思考预算级别:“think” < “think hard” < “think harder” < “ultrathink”。每个级别都会为 Claude 分配更多的思考预算。
- 如果这一步的结果看起来合理,您可以让 Claude 创建一个文档或一个 GitHub issue 来记录它的计划,这样如果实现(步骤3)不符合您的要求,您可以重置到这个点。
要求 Claude 用代码实现其解决方案。这也是一个好时机,可以要求它在实现解决方案的各个部分时明确验证其解决方案的合理性。
要求 Claude 提交结果并创建一个拉取请求。如果相关,这也是让 Claude 更新任何 README 或变更日志以解释它刚刚做了什么的好时机。
步骤 #1-#2 至关重要—没有它们,Claude 倾向于直接开始编码解决方案。虽然有时这就是您想要的,但要求 Claude 先研究和计划,可以显著提高需要预先进行更深入思考的问题的性能。
b. 编写测试(Write tests),提交(commit);编码(code),迭代(iterate),提交(commit)
这是 Anthropic 最喜欢的工作流程,适用于可以通过单元、集成或端到端测试轻松验证的更改。测试驱动开发(TDD)在代理式编码中变得更加强大:
要求 Claude 根据预期的输入/输出对编写测试。明确说明您正在进行测试驱动开发,以便它避免创建模拟实现,即使对于代码库中尚不存在的功能也是如此。
告诉 Claude 运行测试并确认它们失败。明确告诉它在这个阶段不要编写任何实现代码通常很有帮助。
当您对测试满意时,要求 Claude 提交测试。
要求 Claude 编写通过测试的代码,指示它不要修改测试。告诉 Claude 继续进行,直到所有测试都通过。通常 Claude 需要几次迭代来编写代码、运行测试、调整代码,然后再次运行测试。
- 在这个阶段,可以要求它用独立的子代理验证实现是否对测试过拟合。
当您对更改满意时,要求 Claude 提交代码。
当 Claude 有一个明确的目标可以迭代时,它的表现最好——一个视觉模型、一个测试用例或其他类型的输出。通过提供像测试这样的预期输出,Claude 可以进行更改、评估结果,并逐步改进直到成功。
c. 编写代码,截取结果,迭代
与测试工作流程类似,您可以为 Claude 提供视觉目标:
给 Claude 一种截取浏览器屏幕截图的方法(例如,使用Puppeteer MCP 服务器、iOS 模拟器 MCP 服务器,或者手动复制/粘贴屏幕截图到 Claude 中)。
通过复制/粘贴或拖放图像,或者给 Claude 图像文件路径来提供视觉模型。
要求 Claude 在代码中实现设计,截取结果的屏幕截图,并迭代直到其结果与模型匹配。
当您满意时,要求 Claude 提交。
和人类一样,Claude 的输出往往会随着迭代显著改善。虽然第一个版本可能不错,但经过2-3次迭代后,它通常看起来会好得多。为了获得最佳结果,请给 Claude 工具来查看其输出。

d. 安全的 YOLO 模式
您可以不监督 Claude,而是使用 claude --dangerously-skip-permissions 来绕过所有权限检查,让 Claude 不间断地工作直到完成。这对于修复 lint 错误或生成样板代码等工作流程非常有效。
让 Claude 运行任意命令是有风险的,可能导致数据丢失、系统损坏,甚至数据泄露(例如,通过提示注入攻击)。为了最小化这些风险,请在没有互联网访问的容器中使用 --dangerously-skip-permissions。您可以遵循这个使用 Docker Dev Containers 的参考实现。
e. 代码库问答
在熟悉新代码库时,使用 Claude Code 进行学习和探索。您可以向 Claude 提出与在结对编程时向项目中的另一位工程师提出的同类问题。Claude 可以代理式地搜索代码库来回答一般性问题,例如:
- 日志系统是如何工作的?
- 如何创建一个新的 API 端点?
foo.rs文件第 134 行的async move { ... }是做什么的?CustomerOnboardingFlowImpl处理了哪些边界情况?- 为什么我们在第 333 行调用
foo()而不是bar()? baz.py文件第 334 行的代码在 Java 中对应的是什么?
在 Anthropic,以这种方式使用 Claude Code 已成为我们的核心入职工作流程,显著缩短了上手时间并减轻了其他工程师的负担。无需特殊提示!只需提问,Claude 就会探索代码以找到答案。

f. 使用 Claude 与 git 交互
Claude 可以有效地处理许多 git 操作。许多 Anthropic 的工程师使用 Claude 进行 90% 以上的 git 交互:
- 搜索 git 历史以回答诸如“v1.2.3 版本中包含了哪些更改?”、“这个特定功能的所有者是谁?”或“为什么这个 API 是这样设计的?”之类的问题。明确提示 Claude 查阅 git 历史来回答这类问题会很有帮助。
- 编写提交信息。Claude 会自动查看您的更改和最近的历史记录,以撰写一条考虑了所有相关上下文的信息。
- 处理复杂的 git 操作,如还原文件、解决 rebase 冲突以及比较和嫁接补丁。
g. 使用 Claude 与 GitHub 交互
Claude Code 可以管理许多 GitHub 交互:
- 创建拉取请求:Claude 理解“pr”这个简写,并会根据 diff 和周围的上下文生成适当的提交信息。
- 对简单的代码审查评论进行一次性解决:只需告诉它修复您 PR 上的评论(可选地,给它更具体的指令),并在完成后推送到 PR 分支。
- 修复失败的构建或 linter 警告
- 通过要求 Claude 遍历开放的 GitHub issue 来分类和分流它们
这消除了记住 gh 命令行语法的需要,同时自动化了日常任务。
h. 使用 Claude 处理 Jupyter notebook
Anthropic 的研究人员和数据科学家使用 Claude Code 来读写 Jupyter notebook。Claude 可以解释输出,包括图像,为探索和与数据交互提供了一种快速的方式。没有必需的提示或工作流程,但我们推荐的一个工作流程是在 VS Code 中并排打开 Claude Code 和一个 .ipynb 文件。
您还可以要求 Claude 在向同事展示之前,清理或美化您的 Jupyter notebook。明确告诉它使 notebook 或其数据可视化“美观”有助于提醒它正在为人类的观看体验进行优化。
4. 优化您的工作流程
以下建议适用于所有工作流程:
a. 在您的指令中要具体
Claude Code 的成功率随着更具体的指令而显著提高,尤其是在初次尝试时。预先给出明确的方向可以减少之后进行路线修正的需要。
例如:
| 差 | 好 |
|---|---|
| 为 foo.py 添加测试 | 为 foo.py 编写一个新的测试用例,覆盖用户未登录的边界情况。避免使用 mock。 |
| 为什么 ExecutionFactory 的 api 这么奇怪? | 查看 ExecutionFactory 的 git 历史,总结其 api 是如何演变而来的。 |
| 添加一个日历小部件 | 查看主页上现有小部件的实现方式,以了解模式,特别是代码和接口是如何分离的。HotDogWidget.php 是一个很好的起点。然后,遵循该模式实现一个新的日历小部件,让用户可以选择月份并向前/向后翻页以选择年份。除了代码库中已经使用的库之外,不要使用其他库,从头开始构建。 |
Claude 可以推断意图,但它无法读懂您的心思。具体性能够更好地与期望保持一致。

b. 给 Claude 图片
Claude 通过多种方法在处理图像和图表方面表现出色:
- 粘贴屏幕截图(专业提示:在 macOS 中按
cmd+ctrl+shift+4将屏幕截图复制到剪贴板,然后按ctrl+v粘贴。请注意,这不同于您通常在 Mac 上用于粘贴的cmd+v,并且在远程操作时无效。) - 直接拖放图像到提示输入框中
- 提供图像的文件路径
这在处理作为 UI 开发参考点的设计模型以及用于分析和调试的可视化图表时特别有用。如果您没有向上下文中添加视觉元素,向 Claude 明确说明结果在视觉上吸引人的重要性仍然很有帮助。

c. 提及您希望 Claude 查看或处理的文件
使用 tab 键补全功能快速引用您仓库中任何地方的文件或文件夹,帮助 Claude 找到或更新正确的资源。

d. 给 Claude URL
将特定的 URL 与您的提示一起粘贴,供 Claude 获取和阅读。为避免对相同域名(例如,docs.foo.com)的权限提示,请使用 /permissions 将域名添加到您的允许列表中。
e. 尽早并经常进行路线修正
虽然自动接受模式(按 shift+tab 切换)让 Claude 自主工作,但通过作为积极的协作者并指导 Claude 的方法,您通常会获得更好的结果。您可以通过在开始时向 Claude 彻底解释任务来获得最佳结果,但您也可以随时修正 Claude 的路线。
这四个工具有助于进行路线修正:
- 在编码前要求 Claude 制定计划。明确告诉它在您确认其计划可行之前不要编码。
- 在任何阶段(思考、工具调用、文件编辑)按 Escape 键中断 Claude,同时保留上下文,以便您可以重新定向或扩展指令。
- 双击 Escape 键跳回历史记录,编辑先前的提示,并探索不同的方向。您可以编辑提示并重复,直到获得您想要的结果。
- 要求 Claude 撤销更改,通常与选项 #2 结合使用,以采取不同的方法。
虽然 Claude Code 偶尔会在第一次尝试时就完美地解决问题,但使用这些修正工具通常能更快地产生更好的解决方案。
f. 使用 /clear 保持上下文集中
在长时间的会话中,Claude 的上下文窗口可能会被不相关的对话、文件内容和命令填满。这会降低性能,有时还会分散 Claude 的注意力。在任务之间频繁使用 /clear 命令来重置上下文窗口。
g. 对复杂工作流程使用清单和草稿板
对于具有多个步骤或需要详尽解决方案的大型任务——如代码迁移、修复大量 lint 错误或运行复杂的构建脚本——通过让 Claude 使用 Markdown 文件(甚至是一个 GitHub issue!)作为清单和工作草稿板来提高性能:
例如,要修复大量的 lint 问题,您可以执行以下操作:
- 告诉 Claude 运行 lint 命令并将所有产生的错误(包括文件名和行号)写入一个 Markdown 清单中
- 指示 Claude 逐个解决每个问题,在修复和验证后将其勾选掉,然后继续下一个
h. 将数据传递给 Claude
有几种方法可以向 Claude 提供数据:
- 直接复制粘贴到您的提示中(最常见的方法)
- 通过管道传入 Claude Code(例如,
cat foo.txt | claude),对于日志、CSV 和大数据特别有用 - 告诉 Claude 通过 bash 命令、MCP 工具或自定义斜杠命令拉取数据
- 要求 Claude 读取文件或获取 URL(对图像也适用)
大多数会话都涉及这些方法的组合。例如,您可以通过管道传入一个日志文件,然后告诉 Claude 使用一个工具来拉取额外的上下文来调试日志。
5. 使用无头模式自动化您的基础设施
Claude Code 包含无头模式,用于非交互式环境,如 CI、预提交钩子、构建脚本和自动化。使用 -p 标志和一个提示来启用无头模式,并使用 --output-format stream-json 来获取流式 JSON 输出。
请注意,无头模式在会话之间不会持久化。您必须在每个会话中触发它。
a. 使用 Claude 进行 issue 分流
无头模式可以驱动由 GitHub 事件触发的自动化,例如当您的仓库中创建新 issue 时。例如,公共的 Claude Code 仓库 使用 Claude 来检查新进入的 issue 并分配适当的标签。
b. 使用 Claude 作为 linter
Claude Code 可以提供主观的代码审查,超越传统 linting 工具所能检测的范围,识别诸如拼写错误、过时的注释、误导性的函数或变量名等问题。
6. 通过多 Claude 工作流程提升水平
除了独立使用之外,一些最强大的应用涉及并行运行多个 Claude 实例:
a. 让一个 Claude 编写代码;用另一个 Claude 来验证
一个简单但有效的方法是让一个 Claude 编写代码,而另一个则审查或测试它。类似于与多位工程师合作,有时拥有独立的上下文是有益的:
- 使用 Claude 编写代码
- 运行
/clear或在另一个终端中启动第二个 Claude - 让第二个 Claude 审查第一个 Claude 的工作
- 启动另一个 Claude(或再次
/clear)来阅读代码和审查反馈 - 让这个 Claude 根据反馈编辑代码
您可以用测试做类似的事情:让一个 Claude 编写测试,然后让另一个 Claude 编写代码以使测试通过。您甚至可以让您的 Claude 实例通过给它们各自独立的工作草稿板并告诉它们哪个写入哪个读取来进行通信。
这种分离通常比让单个 Claude 处理所有事情产生更好的结果。
b. 拥有多个仓库的检出副本
许多 Anthropic 的工程师不是等待 Claude 完成每一步,而是这样做:
- 在不同的文件夹中创建 3-4 个 git 检出副本
- 在不同的终端标签页中打开每个文件夹
- 在每个文件夹中以不同的任务启动 Claude
- 循环检查进度并批准/拒绝权限请求
c. 使用 git worktrees
这种方法在处理多个独立任务时表现出色,提供了一种比多个检出副本更轻量级的替代方案。Git worktrees 允许您将同一仓库的多个分支检出到不同的目录中。每个 worktree 都有自己的工作目录和隔离的文件,同时共享相同的 Git 历史和 reflog。
使用 git worktrees 使您能够同时在项目的不同部分上运行多个 Claude 会话,每个会话都专注于其独立的任务。例如,您可能让一个 Claude 重构您的认证系统,而另一个则构建一个完全不相关的数据可视化组件。由于任务不重叠,每个 Claude 都可以全速工作,而无需等待对方的更改或处理合并冲突:
创建 worktrees:
git worktree add ../project-feature-a feature-a在每个 worktree 中启动 Claude:
cd ../project-feature-a && claude根据需要创建额外的 worktrees(在新的终端标签页中重复步骤1-2)
一些技巧:使用一致的命名约定
每个 worktree 维护一个终端标签页
如果您在 Mac 上使用 iTerm2,请设置通知以便在 Claude 需要注意时得到提醒
为不同的 worktrees 使用不同的 IDE 窗口
完成后清理:
git worktree remove ../project-feature-a
d. 使用带有自定义套件的无头模式
claude -p(无头模式)将 Claude Code 以编程方式集成到更大的工作流程中,同时利用其内置工具和系统提示。使用无头模式主要有两种模式:
扇出(Fanning out) 处理大规模迁移或分析(例如,分析数百个日志中的情绪或分析数千个 CSV):
- 让 Claude 编写一个脚本来生成任务列表。例如,生成一个需要从框架 A 迁移到框架 B 的 2000 个文件的列表。
- 循环遍历任务,为每个任务以编程方式调用 Claude,并给它一个任务和一组它可以使用的工具。例如:
claude -p “将 foo.py 从 React 迁移到 Vue。完成后,如果成功,你必须返回字符串 OK,如果任务失败,则返回 FAIL。” --allowedTools Edit Bash(git commit:*) - 多次运行脚本并优化您的提示以获得期望的结果。
流水线(Pipelining) 将 Claude 集成到现有的数据/处理流水线中:
- 调用
claude -p “<你的提示>” --json | your_command,其中your_command是您处理流水线的下一步 - 就这样!JSON 输出(可选)可以帮助提供结构,以便于自动处理。
- 调用
对于这两种用例,使用 --verbose 标志进行调试 Claude 调用会很有帮助。我们通常建议在生产环境中关闭详细模式以获得更清晰的输出。
您在使用 Claude Code 方面有什么技巧和最佳实践?标记 @AnthropicAI,让我们看看您在构建什么!