文档索引

在此获取完整文档索引：https://code.claude.com/docs/llms.txt 使用此文件发现所有可用页面，然后再进一步探索。

常见工作流

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

本页面收集了日常开发的简短方案。有关提示和上下文管理的更高层次指导，请参阅最佳实践。

本页面涵盖：

• 提示方案：用于探索代码、修复 bug、重构、测试、PR 和文档
• 恢复之前的对话：使任务可以跨多个会话
• 使用工作树运行并行会话：使并发编辑不会冲突
• 编辑前先规划：在更改写入磁盘之前审查更改
• 将研究委派给子代理：保持主上下文干净
• 将 Claude 管道到脚本中：用于 CI 和批处理

提示方案

这些是用于日常任务的提示模式，如探索不熟悉的代码、调试、重构、编写测试和创建 PR。每个方案适用于任何 Claude Code 界面；根据您的项目调整措辞。

理解新代码库

有关在 monorepo 或大型代码库中配置 Claude Code，请参阅Monorepo 和大型仓库。

获取快速代码库概览

假设您刚加入一个新项目，需要快速了解其结构。

1. 导航到项目根目录

   cd /path/to/project 
   

2. 启动 Claude Code

   claude 
   

3. 请求高层概览

   give me an overview of this codebase
   

4. 深入了解特定组件

   explain the main architecture patterns used here
   

   what are the key data models?
   

   how is authentication handled?
   

查找相关代码

假设您需要定位与特定功能或特性相关的代码。

1. 让 Claude 查找相关文件

   find the files that handle user authentication
   

2. 获取组件如何交互的上下文

   how do these authentication files work together?
   

3. 理解执行流程

   trace the login process from front-end to database
   

高效修复 bug

假设您遇到了错误消息，需要找到并修复其来源。

1. 与 Claude 分享错误

   I'm seeing an error when I run npm test
   

2. 请求修复建议

   suggest a few ways to fix the @ts-ignore in user.ts
   

3. 应用修复

   update user.ts to add the null check you suggested
   

重构代码

假设您需要更新旧代码以使用现代模式和实践。

1. 识别需要重构的遗留代码

   find deprecated API usage in our codebase
   

2. 获取重构建议

   suggest how to refactor utils.js to use modern JavaScript features
   

3. 安全地应用更改

   refactor utils.js to use ES2024 features while maintaining the same behavior
   

4. 验证重构

   run tests for the refactored code
   

使用测试

假设您需要为未覆盖的代码添加测试。

1. 识别未测试的代码

   find functions in NotificationsService.swift that are not covered by tests
   

2. 生成测试脚手架

   add tests for the notification service
   

3. 添加有意义的测试用例

   add test cases for edge conditions in the notification service
   

4. 运行并验证测试

   run the new tests and fix any failures
   

Claude 可以生成遵循您项目现有模式和约定的测试。在请求测试时，请具体说明您想要验证的行为。Claude 会检查您现有的测试文件以匹配正在使用的风格、框架和断言模式。

要获得全面覆盖，请让 Claude 识别您可能遗漏的边界情况。Claude 可以分析您的代码路径并建议针对错误条件、边界值和意外输入的测试，这些很容易被忽略。

创建拉取请求

您可以通过直接要求 Claude 来创建拉取请求（"create a pr for my changes"），或逐步指导 Claude：

1. 总结您的更改

   summarize the changes I've made to the authentication module
   

2. 生成拉取请求

   create a pr
   

3. 审查和完善

   enhance the PR description with more context about the security improvements
   

当您使用 gh pr create 创建 PR 时，会话会自动链接到该 PR。要稍后返回，请运行 claude --from-pr <number> 或将 PR URL 粘贴到 /resume 选择器搜索中。

处理文档

假设您需要为代码添加或更新文档。

1. 识别未文档化的代码

   find functions without proper JSDoc comments in the auth module
   

2. 生成文档

   add JSDoc comments to the undocumented functions in auth.js
   

3. 审查和增强

   improve the generated documentation with more context and examples
   

4. 验证文档

   check if the documentation follows our project standards
   

在笔记和非代码文件夹中工作

Claude Code 可在任何目录中工作。在笔记库、文档文件夹或任何 markdown 文件集合中运行它，以搜索、编辑和重组内容，就像处理代码一样。

.claude/ 目录和 CLAUDE.md 与其他工具的配置目录并存，不会冲突。Claude 在每次工具调用时都会重新读取文件，因此在下次读取该文件时会看到您在另一个应用程序中进行的编辑。

使用图像

假设您需要处理代码库中的图像，并且希望 Claude 帮助分析图像内容。

1. 向对话中添加图像

   您可以使用以下任何方法：

   1. 将图像拖放到 Claude Code 窗口中
   2. 复制图像并使用 ctrl+v 粘贴到 CLI 中（不要使用 cmd+v）
   3. 向 Claude 提供图像路径。例如，"Analyze this image: /path/to/your/image.png"

2. 让 Claude 分析图像

   What does this image show?
   

   Describe the UI elements in this screenshot
   

   Are there any problematic elements in this diagram?
   

3. 使用图像作为上下文

   Here's a screenshot of the error. What's causing it?
   

   This is our current database schema. How should we modify it for the new feature?
   

4. 从视觉内容获取代码建议

   Generate CSS to match this design mockup
   

   What HTML structure would recreate this component?
   

引用文件和目录

使用 @ 快速包含文件或目录，无需等待 Claude 读取它们。

1. 引用单个文件

   Explain the logic in @src/utils/auth.js
   

   这会将文件的完整内容包含在对话中。

2. 引用目录

   What's the structure of @src/components?
   

   这会提供带有文件信息的目录列表。

3. 引用 MCP 资源

   Show me the data from @github:repos/owner/repo/issues
   

   这会使用 @server:resource 格式从连接的 MCP 服务器获取数据。详情请参阅 MCP 资源。

定时运行 Claude

假设您希望 Claude 自动定期处理任务，例如每天早上审查打开的 PR、每周审计依赖项或在夜间检查 CI 失败。

根据您希望任务运行的位置选择调度选项：

询问 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 Code 在本地保存每个对话。

claude --continue

这会恢复当前目录中的最近会话；如果还没有，则打印 No conversation found to continue 并退出。使用 claude --resume 从列表中选择，或在运行中的会话中使用 /resume。有关命名、分支和完整选择器参考，请参阅管理会话。

使用工作树运行并行会话

在一个终端中处理功能，同时 Claude 在另一个终端中修复 bug，而不会导致编辑冲突。每个工作树是其自己分支上的单独检出。

claude --worktree feature-auth

在第二个终端中使用不同的名称运行相同的命令以启动隔离的并行会话。有关清理、.worktreeinclude 和非 git VCS 支持，请参阅工作树。要从一个屏幕而不是单独的终端监视并行会话，请参阅后台代理。

编辑前先规划

对于您想在写入磁盘之前审查的更改，请切换到计划模式。Claude 读取文件并提出计划，但在您批准之前不进行任何编辑。

claude --permission-mode plan

您也可以在会话中按 Shift+Tab 切换到计划模式。有关审批流程和在文本编辑器中编辑计划，请参阅计划模式。

将研究委派给子代理

探索大型代码库会用文件读取填满您的上下文。委派探索工作，只返回结果。

use a subagent to investigate how our auth system handles token refresh

子代理在其自己的上下文窗口中读取文件并报告摘要。有关定义具有自己工具和提示的自定义代理，请参阅子代理。

将 Claude 管道到脚本中

为 CI、pre-commit 钩子或批处理非交互式运行 Claude。Stdin 和 stdout 像任何 Unix 工具一样工作。

git log --oneline -20 | claude -p "summarize these recent commits"

有关输出格式、权限标志和扇出模式，请参阅非交互模式。

后续步骤