代码库入门引导

系统性地分析一个不熟悉的代码库，并生成结构化的入门指南。专为加入新项目的开发者或首次在现有仓库中设置 Claude Code 的用户设计。

使用时机

• 首次使用 Claude Code 打开项目时
• 加入新团队或新仓库时
• 用户询问“帮我理解这个代码库”
• 用户要求为项目生成 CLAUDE.md 文件
• 用户说“带我入门”或“带我浏览这个仓库”

工作原理

阶段 1：初步侦察

在不阅读每个文件的情况下，收集关于项目的原始信息。并行运行以下检查：

1. 包清单检测
   → package.json、go.mod、Cargo.toml、pyproject.toml、pom.xml、build.gradle、
     Gemfile、composer.json、mix.exs、pubspec.yaml

2. 框架指纹识别
   → next.config.*、nuxt.config.*、angular.json、vite.config.*、
     django 设置、flask 应用工厂、fastapi 主程序、rails 配置

3. 入口点识别
   → main.*、index.*、app.*、server.*、cmd/、src/main/

4. 目录结构快照
   → 目录树的前 2 层，忽略 node_modules、vendor、
     .git、dist、build、__pycache__、.next

5. 配置与工具检测
   → .eslintrc*、.prettierrc*、tsconfig.json、Makefile、Dockerfile、
     docker-compose*、.github/workflows/、.env.example、CI 配置

6. 测试结构检测
   → tests/、test/、__tests__/、*_test.go、*.spec.ts、*.test.js、
     pytest.ini、jest.config.*、vitest.config.*

阶段 2：架构映射

根据侦察数据，识别：

技术栈

• 语言及版本限制
• 框架及主要库
• 数据库及 ORM
• 构建工具和打包器
• CI/CD 平台

架构模式

• 单体、单体仓库、微服务，还是无服务器
• 前端/后端分离，还是全栈
• API 风格：REST、GraphQL、gRPC、tRPC

关键目录 将顶级目录映射到其用途：

<!-- Example for a React project — replace with detected directories -->

src/components/ …