跳转至

代码库入门

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

使用时机

  • 首次在 Claude Code 中打开项目
  • 加入新团队或新仓库
  • 用户要求“请帮助我理解这个代码库”
  • 用户要求生成项目的 CLAUDE.md
  • 用户说“onboard”或“解释这个仓库”

工作方式

阶段 1：侦察

在不读取所有文件的情况下，收集有关项目的原始信号。并行执行以下检查：

1. パッケージマニフェスト検出
   → package.json, go.mod, Cargo.toml, pyproject.toml, pom.xml

2. フレームワークフィンガープリント
   → next.config、nuxt.config、angular.json、vite.config

3. エントリポイント識別
   → main.*、index.*、app.*、server.*

4. ディレクトリ構造スナップショット
   → ディレクトリツリーの最上位2レベル

5. コンフィグとツール検出
   → .eslintrc、.prettierrc、tsconfig.json、Dockerfile

6. テスト構造検出
   → tests/、__tests__/、*.spec.ts、jest.config.*

阶段 2：架构地图

识别主要模块及其关系。

阶段 3：约定与风格

识别代码约定、命名模式和项目特定模式。

输出

  • 架构地图
  • 主要入口点和流程
  • 约定与风格指南
  • 入门 CLAUDE.md

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 ev/ECC