Claude 编码:具身智能编码的最佳实践
原文地址 www.anthropic.com
一篇涵盖了在各种场景下有效使用 Claude Code 的技巧和窍门的博客文章......
我们最近发布了 Claude Code,这是一个用于智能编程的命令行工具。作为一个研究项目开发,Claude Code 为 Anthropic 的工程师和研究人员提供了一种更原生的方式来将 Claude 集成到他们的编程工作流程中。
Claude Code 故意设计得底层且不带偏见,提供接近原始模型访问的能力,而不强制特定的工作流程。这种设计理念创造了一个灵活、可定制、可脚本化且安全的强大工具。虽然功能强大,但这种灵活性为刚接触智能编程工具的工程师带来了学习曲线——至少在他们形成自己的最佳实践之前。
这篇文章概述了已被证明有效的通用模式,既适用于 Anthropic 的内部团队,也适用于在各种代码库、语言和环境中使用 Claude Code 的外部工程师。此清单中的内容都不是一成不变的,也不是普遍适用的;请将这些建议视为起点。我们鼓励您进行实验,找到最适合您的方法!
寻找更详细的信息?我们在 claude.ai/code 的综合文档涵盖了本文提到的所有功能,并提供了额外的示例、实现细节和高级技术。
1. 自定义您的设置
Claude Code 是一个智能编程助手,会自动将上下文拉入提示中。这种上下文收集会消耗时间和令牌,但您可以通过环境调优来优化它。
a. 创建 CLAUDE.md
文件
CLAUDE.md
是一个特殊文件,Claude 在开始对话时会自动将其拉入上下文。这使其成为记录以下内容的理想场所:
- 常用的 bash 命令
- 核心文件和实用函数
- 代码风格指南
- 测试指令
- 仓库礼仪(例如,分支命名、合并与变基等)
- 开发环境设置(例如,pyenv use,哪些编译器有效)
- 项目特有的任何意外行为或警告
- 您希望 Claude 记住的其他信息
CLAUDE.md
文件没有必需的格式。我们建议保持简洁且人类可读。例如:
# Bash 命令
- npm run build: 构建项目
- npm run typecheck: 运行类型检查
# 代码风格
- 使用 ES 模块 (import/export) 语法,而不是 CommonJS (require)
- 尽可能解构导入 (eg. import { foo } from 'bar')
# 工作流程
- 完成一系列代码更改后务必进行类型检查
- 出于性能考虑,优先运行单个测试,而不是整个测试套件
您可以将 CLAUDE.md
文件放置在几个位置:
- 仓库的根目录,或您运行
claude
的任何地方(最常见的用法)。将其命名为CLAUDE.md
并检入 git,以便可以跨会话和与团队共享(推荐),或将其命名为CLAUDE.local.md
并.gitignore
它 - 您运行
claude
的目录的任何父目录。这对于单体仓库最有用,您可能从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
文件,并经常调优指令(例如,添加"重要"或"您必须"等强调)以提高遵循性。
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
(我们建议将前者检入源代码控制以与团队共享)。 - 使用
--allowedTools
CLI 标志进行会话特定权限。
d. 如果使用 GitHub,请安装 gh CLI
Claude 知道如何使用 gh
CLI 与 GitHub 交互,用于创建问题、打开拉取请求、阅读评论等。没有安装 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 问题的斜杠命令:
请分析并修复 GitHub 问题:$ARGUMENTS。
按照以下步骤:
1. 使用 `gh issue view` 获取问题详情
2. 理解问题中描述的问题
3. 搜索代码库中的相关文件
4. 实施必要的更改来修复问题
5. 编写并运行测试以验证修复
6. 确保代码通过 linting 和类型检查
7. 创建描述性的提交消息
8. 推送并创建 PR
记住对所有 GitHub 相关任务使用 GitHub CLI (`gh`)。
将上述内容放入 .claude/commands/fix-github-issue.md
使其在 Claude Code 中作为 /project:fix-github-issue
命令可用。然后您可以例如使用 /project:fix-github-issue 1234
让 Claude 修复问题 #1234。类似地,您可以将您自己的个人命令添加到 ~/.claude/commands
文件夹,用于您希望在所有会话中可用的命令。
3. 尝试常见工作流程
Claude Code 不强制特定的工作流程,为您提供按自己想要的方式使用它的灵活性。在这种灵活性提供的空间内,几个成功有效使用 Claude Code 的模式已在我们的用户社区中出现:
a. 探索、计划、编程、提交
这个多功能工作流程适合许多问题:
- 要求 Claude 阅读相关文件、图像或 URL,提供一般指针("阅读处理日志记录的文件")或特定文件名("阅读 logging.py"),但明确告诉它暂时不要编写任何代码。
- 这是工作流程中您应该考虑大量使用子代理的部分,特别是对于复杂问题。告诉 Claude 使用子代理来验证细节或调查它可能有的特定问题,特别是在对话或任务的早期,往往会保持上下文可用性,而在效率损失方面没有太多缺点。
- 要求 Claude 制定解决特定问题的计划。我们建议使用"think"这个词来触发扩展思考模式,这为 Claude 提供额外的计算时间来更彻底地评估替代方案。这些特定短语直接映射到系统中增加的思考预算水平:"think" < "think hard" < "think harder" < "ultrathink"。每个级别为 Claude 使用分配逐渐更多的思考预算。
- 如果此步骤的结果看起来合理,您可以让 Claude 创建一个文档或 GitHub 问题来记录其计划,以便如果实施(第 3 步)不是您想要的,您可以重置到这个点。
- 要求 Claude 在代码中实施其解决方案。这也是一个要求它在实施解决方案的各个部分时明确验证其解决方案合理性的好地方。
- 要求 Claude 提交结果并创建拉取请求。如果相关,这也是让 Claude 用它刚做的事情的解释更新任何 README 或变更日志的好时机。
步骤 #1-#2 至关重要——没有它们,Claude 倾向于直接跳到编程解决方案。虽然有时这是您想要的,但要求 Claude 首先进行研究和计划显著提高了需要深入思考的问题的性能。
b. 编写测试,提交;编程,迭代,提交
这是 Anthropic 最喜欢的工作流程,用于可以通过单元、集成或端到端测试轻松验证的更改。测试驱动开发(TDD)在智能编程中变得更加强大:
- 要求 Claude 基于预期的输入/输出对编写测试。明确说明您正在进行测试驱动开发,以便它避免创建模拟实现,即使对于代码库中尚不存在的功能也是如此。
- 告诉 Claude 运行测试并确认它们失败。在这个阶段明确告诉它不要编写任何实现代码通常很有帮助。
- 当您对测试满意时,要求 Claude 提交测试。
- 要求 Claude 编写通过测试的代码,指示它不要修改测试。告诉 Claude 继续直到所有测试通过。Claude 通常需要几次迭代来编写代码、运行测试、调整代码并再次运行测试。
- 在这个阶段,让它用独立的子代理验证实现没有过度拟合测试可能会有帮助
- 一旦您对更改满意,要求 Claude 提交代码。
当 Claude 有明确的目标进行迭代时——视觉模拟、测试用例或其他类型的输出——它表现最佳。通过提供像测试这样的预期输出,Claude 可以进行更改、评估结果并逐步改进直到成功。
c. 编写代码,截图结果,迭代
类似于测试工作流程,您可以为 Claude 提供视觉目标:
- 为 Claude 提供拍摄浏览器截图的方法(例如,使用 Puppeteer MCP 服务器、iOS 模拟器 MCP 服务器,或手动复制/粘贴截图到 Claude)。
- 通过复制/粘贴或拖放图像,或给 Claude 图像文件路径,为 Claude 提供视觉模拟。
- 要求 Claude 在代码中实施设计,拍摄结果截图,并迭代直到其结果与模拟匹配。
- 当您满意时要求 Claude 提交。
像人类一样,Claude 的输出通过迭代往往会显著改善。虽然第一个版本可能不错,但经过 2-3 次迭代后通常会看起来好得多。为 Claude 提供查看其输出的工具以获得最佳结果。
d. 安全的 YOLO 模式
您可以使用 claude --dangerously-skip-permissions
绕过所有权限检查并让 Claude 不间断地工作直到完成,而不是监督 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 操作,如恢复文件、解决变基冲突以及比较和移植补丁
g. 使用 Claude 与 GitHub 交互
Claude Code 可以管理许多 GitHub 交互:
- 创建拉取请求:Claude 理解简写"pr",并将基于 diff 和周围上下文生成适当的提交消息。
- 实施简单代码审查评论的一次性解决方案:只需告诉它修复您 PR 上的评论(可选地,给它更具体的指令),完成后推送回 PR 分支。
- 修复失败的构建或 linter 警告
- 通过要求 Claude 循环遍历开放的 GitHub 问题来分类和筛选开放问题
这消除了记住 gh
命令行语法的需要,同时自动化例行任务。
h. 使用 Claude 处理 Jupyter 笔记本
Anthropic 的研究人员和数据科学家使用 Claude Code 来读写 Jupyter 笔记本。Claude 可以解释输出,包括图像,提供了一种快速探索和与数据交互的方式。没有必需的提示或工作流程,但我们推荐的工作流程是在 VS Code 中并排打开 Claude Code 和 .ipynb
文件。
您还可以要求 Claude 在向同事展示之前清理或对您的 Jupyter 笔记本进行美学改进。特别告诉它使笔记本或其数据可视化"美观"往往有助于提醒它正在为人类观看体验进行优化。
4. 优化您的工作流程
以下建议适用于所有工作流程:
a. 在指令中要具体
Claude Code 的成功率随着更具体的指令显著提高,特别是在第一次尝试时。预先给出明确的方向减少了后续纠正方向的需要。
例如:
差 | 好 |
---|---|
为 foo.py 添加测试 | 为 foo.py 编写一个新的测试用例,涵盖用户注销的边缘情况。避免模拟 |
为什么 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 问题!)作为检查清单和工作草稿板来提高性能:
例如,要修复大量 lint 问题,您可以执行以下操作:
- 告诉 Claude 运行 lint 命令并将所有结果错误(带文件名和行号)写入 Markdown 检查清单
- 指示 Claude 逐一解决每个问题,修复和验证后检查并移至下一个
h. 将数据传入 Claude
向 Claude 提供数据存在几种方法:
- 直接复制粘贴到您的提示中(最常见的方法)
- 管道传入 Claude Code(例如,
cat foo.txt | claude
),对日志、CSV 和大型数据特别有用 - 告诉 Claude 通过 bash 命令、MCP 工具或自定义斜杠命令拉取数据
- 要求 Claude 读取文件或获取 URL(也适用于图像)
大多数会话涉及这些方法的组合。例如,您可以管道传入日志文件,然后告诉 Claude 使用工具拉入额外上下文来调试日志。
- 使用无头模式自动化您的基础设施
Claude Code 包含用于非交互式上下文(如 CI、预提交钩子、构建脚本和自动化)的无头模式。使用 -p
标志和提示启用无头模式,使用 --output-format stream-json
进行流式 JSON 输出。
注意无头模式不会在会话之间持久化。您必须在每个会话中触发它。
a. 使用 Claude 进行问题分类
无头模式可以为由 GitHub 事件触发的自动化提供动力,例如在您的仓库中创建新问题时。例如,公共 Claude Code 仓库使用 Claude 检查新问题并分配适当的标签。
b. 使用 Claude 作为 linter
Claude Code 可以提供超越传统 linting 工具检测的主观代码审查,识别诸如拼写错误、过时评论、误导性函数或变量名等问题。
- 使用多 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 程序化地集成到更大的工作流程中,同时利用其内置工具和系统提示。使用无头模式有两种主要模式:
-
扇出处理大型迁移或分析(例如,分析数百个日志中的情感或分析数千个 CSV):
-
让 Claude 编写脚本生成任务列表。例如,生成需要从框架 A 迁移到框架 B 的 2k 文件列表。
-
循环遍历任务,为每个任务程序化调用 Claude,给它一个任务和一组可以使用的工具。例如:
claude -p "将 foo.py 从 React 迁移到 Vue。完成后,如果成功您必须返回字符串 OK,如果任务失败则返回 FAIL。" --allowedTools Edit Bash(git commit:*)
-
多次运行脚本并精炼您的提示以获得所需结果。
-
管道化将 Claude 集成到现有的数据/处理管道中:
-
调用
claude -p "<你的提示>" --json | your_command
,其中your_command
是处理管道的下一步 -
就是这样!JSON 输出(可选)可以帮助为更容易的自动化处理提供结构。
对于这两种用例,使用 --verbose
标志调试 Claude 调用可能会有帮助。我们通常建议在生产中关闭详细模式以获得更清洁的输出。
您使用 Claude Code 的技巧和最佳实践是什么?标记 @AnthropicAI,这样我们就能看到您正在构建什么!
致谢
由 Boris Cherny 撰写。这项工作汲取了更广泛的 Claude Code 用户社区的最佳实践,他们的创意方法和工作流程继续激励着我们。特别感谢 Daisy Hollman、Ashwin Bhat、Cat Wu、Sid Bidasaria、Cal Rueb、Nodir Turakulov、Barry Zhang、Drew Hodun 和许多其他 Anthropic 工程师,他们对 Claude Code 的宝贵见解和实际经验帮助塑造了这些建议。