常见工作流
AI translation, not an official translation. Refer to the original for technical details.
On this page
文档索引
在以下地址获取完整文档索引:https://code.claude.com/docs/llms.txt 在进一步探索之前,请使用此文件了解所有可用页面。
常见工作流
使用 Claude Code 探索代码库、修复 Bug、重构、测试及其他日常任务的分步指南。
本页收录了日常开发的简短操作方案。有关提示词和上下文管理的更高层次指导,请参阅最佳实践。
本页涵盖:
- 提示词方案——用于探索代码、修复 Bug、重构、测试、PR 及文档
- 恢复之前的对话——使任务可以跨多次会话进行
- 通过 worktree 运行并行会话——避免并发编辑发生冲突
- 编辑前先规划——在变更写入磁盘前进行审查
- 将研究任务委托给子代理——保持主上下文整洁
- 将 Claude 接入脚本——用于 CI 和批处理
提示词方案
以下是用于日常任务的提示词模式,包括探索陌生代码、调试、重构、编写测试和创建 PR。每种模式均适用于任何 Claude Code 界面;请根据您的项目调整措辞。
了解新代码库
有关在 monorepo 或大型代码库中配置 Claude Code 的内容,请参阅 Monorepo 与大型仓库。
快速获取代码库概览
假设您刚加入一个新项目,需要快速了解其结构。
Replace `/path/to/project` with the path to your project.
```text wrap theme={null}
what are the key data models?
```
```text wrap theme={null}
how is authentication handled?
```
- 从宏观问题入手,再逐步缩小到具体领域
- 询问项目中使用的编码规范和模式
- 请求生成项目专用术语的词汇表
查找相关代码
假设您需要定位与某个特性或功能相关的代码。
- 尽量明确描述您要查找的内容
- 使用项目的领域语言
- 为您的语言安装代码智能插件,为 Claude 提供精准的"跳转到定义"和"查找引用"导航能力
高效修复 Bug
假设您遇到了一条错误信息,需要找到并修复其根源。
- 告诉 Claude 用于复现问题的命令,以获取堆栈跟踪
- 提及复现错误的任何步骤
- 告知 Claude 该错误是偶发还是必现
重构代码
假设您需要将旧代码更新为使用现代模式和实践。
有关将整个代码库迁移到新语言的内容,请参阅博客上的 Anthropic 如何使用 Claude Code 进行大规模代码迁移。
- 请 Claude 解释现代方式的优势
- 在需要时,要求变更保持向后兼容性
- 以小而可测试的增量方式进行重构
处理测试
假设您需要为未覆盖的代码添加测试。
Claude 可以生成遵循项目现有模式和规范的测试。在请求测试时,请明确说明您希望验证的行为。Claude 会检查您现有的测试文件,以匹配已在使用的风格、框架和断言模式。
如需全面覆盖,可请 Claude 识别您可能遗漏的边界情况。Claude 能够分析您的代码路径,并针对错误条件、边界值以及容易被忽视的意外输入提出测试建议。
创建 Pull Request
您可以直接让 Claude 创建 Pull Request("create a pr for my changes"),也可以逐步引导 Claude 完成:
若要在之后找到该会话,请使用您自己的 PR 编号运行 claude --from-pr 1234,这将打开筛选到与该 PR 关联的会话的会话选择器;或者将 PR URL 粘贴到 /resume 选择器 的搜索框中。当 Claude 使用 gh pr create 或 glab mr create 创建 PR 时,以及当 Claude 处理现有 PR 时,Claude Code 会将会话链接到该 PR。
处理文档
假设您需要为代码添加或更新文档。
- 指定您想要的文档风格(JSDoc、docstrings 等)
- 要求在文档中包含示例
- 为公共 API、接口和复杂逻辑请求文档
在笔记和非代码文件夹中工作
Claude Code 可在任何目录中工作。在笔记库、文档文件夹或任何 Markdown 文件集合中运行它,可以像处理代码一样搜索、编辑和重新组织内容。
.claude/ 目录和 CLAUDE.md 与其他工具的配置目录并存,互不冲突。Claude 在每次工具调用时都会重新读取文件,因此它会在下次读取文件时看到您在其他应用程序中所做的编辑。
处理图像
假设您需要处理代码库中的图像,并希望 Claude 帮助分析图像内容。
1. Drag and drop an image into the Claude Code window
2. Copy an image and paste it into the CLI with `Ctrl+V`, or with [`Alt+V` on Windows and WSL](/docs/en/interactive-mode#general-controls)
3. Provide an image path to Claude. E.g., "Analyze this image: /path/to/your/image.png"
```text wrap theme={null}
Describe the UI elements in this screenshot
```
```text wrap theme={null}
Are there any problematic elements in this diagram?
```
```text wrap theme={null}
This is our current database schema. How should we modify it for the new feature?
```
```text wrap theme={null}
What HTML structure would recreate this component?
```
- 当文字描述不清晰或过于繁琐时,使用图像
- 包含错误截图、UI 设计或图表以提供更好的上下文
- 您可以在一次对话中处理多张图像
- 图像分析适用于图表、截图、原型设计图等
- 当 Claude 引用图像时(例如
[Image #1]),使用Cmd+Click(Mac)或Ctrl+Click(Windows/Linux)点击链接在默认查看器中打开图像
引用文件和目录
使用 @ 快速包含文件或目录,无需等待 Claude 读取它们。
This includes the full content of the file in the conversation.
This fetches data from connected MCP servers using the format @server:resource. See [MCP resources](/docs/en/mcp#use-mcp-resources) for details.
- 文件路径可以是相对路径或绝对路径
- 输入
@打开路径建议菜单,然后按 Enter 或 Tab 接受高亮显示的路径,再次按 Enter 发送消息 - @ 文件引用会将
CLAUDE.md添加到文件所在目录及其父目录的上下文中 - 目录引用显示文件列表,而非文件内容
- 您可以在单条消息中引用多个文件(例如"@file1.js 和 @file2.js")
按计划运行 Claude
假设您希望 Claude 定期自动处理某项任务,例如每天早上审查未完成的 PR、每周审计依赖项,或在夜间检查 CI 失败情况。
根据您希望任务运行的位置选择调度选项:
| 选项 | 运行位置 | 最适合 |
|---|---|---|
| 例行任务 | 云端,默认由 Anthropic 管理 | 即使您的计算机关闭也应继续运行的任务。除定时计划外,还可由 API 调用或 GitHub 事件触发。在 claude.ai/code/routines 进行配置。 |
| 桌面计划任务 | 您的本地计算机,通过桌面应用运行 | 需要直接访问本地文件、工具或未提交更改的任务。 |
| GitHub Actions | 您的 CI 流水线 | 与仓库事件(如已开启的 PR)绑定的任务,或应与工作流配置并存的定时计划任务。 |
/loop | 当前 CLI 会话 | 会话开启期间的快速轮询。任务在您开启新对话时停止;--resume 和 --continue 可恢复未过期的任务。 |
向 Claude 询问其功能
Claude 内置了对其文档的访问权限,可以回答有关自身功能和限制的问题。
示例问题
can Claude Code create pull requests?
how does Claude Code handle permissions?
what skills are available?
how do I use MCP with Claude Code?
how do I configure Claude Code for Amazon Bedrock?
what are the limitations of Claude Code?
- 无论您使用哪个版本,Claude 始终可以访问最新的 Claude Code 文档
- 提出具体问题以获取详细答案
- Claude 可以解释 MCP 集成、企业配置和高级工作流等复杂功能
恢复之前的对话
当一项任务需要多次工作才能完成时,可以从上次离开的地方继续,而无需重新解释背景信息。Claude Code 会在本地保存每次对话。
claude --continue
此命令会恢复当前目录中最近的一次会话;如果尚无会话,则打印 No conversation found to continue 并退出。使用 claude --resume 从列表中选择会话,或在运行中的会话内使用 /resume。请参阅管理会话,了解命名、分支以及完整的选择器参考。
使用工作树运行并行会话
在一个终端处理功能开发的同时,让 Claude 在另一个终端修复 bug,两者互不干扰。每个 git 工作树 都是基于其独立分支的单独检出,由现有提交创建,因此仓库至少需要有一个提交。
claude --worktree feature-auth
在第二个终端中使用不同名称运行相同命令,即可启动一个隔离的并行会话。在没有提交记录的仓库中,该命令会以 Failed to resolve base branch "HEAD": git rev-parse failed 失败。请参阅工作树,了解清理操作、.worktreeinclude 以及非 git VCS 支持。若要在一个屏幕上监控并行会话而非使用多个独立终端,请参阅后台代理。
编辑前先规划
对于希望在落盘前进行审查的更改,请切换到规划模式。Claude 会读取文件并提出方案,但在您批准之前不会进行任何编辑。规划模式激活时,状态栏会显示 ⏸ plan mode on。
claude --permission-mode plan
您也可以在会话中途按 Shift+Tab,直到状态栏显示 ⏸ plan mode on。请参阅规划模式,了解审批流程以及在文本编辑器中修改方案的方法。
将研究任务委托给子代理
探索大型代码库会将大量文件读取内容填满您的上下文窗口。将探索任务委托出去,这样只有发现的结果会返回给您。
use a subagent to investigate how our auth system handles token refresh
子代理在其自己的上下文窗口中读取文件并返回摘要。请参阅子代理,了解如何定义具有专属工具和提示词的自定义代理。
将 Claude 接入脚本
以非交互模式运行 Claude,用于 CI、预提交钩子或批量处理。标准输入输出的用法与任何 Unix 工具相同。
git log --oneline -20 | claude -p "summarize these recent commits"
请参阅非交互模式,了解输出格式、权限标志和扇出模式。