mcpField
C
codebase-onboarding

codebase-onboarding

github.com/spencerpauly开发869484 次安装13 周前更新
代码仓库

关于 codebase-onboarding

通过并行探索架构、数据模型、API、身份验证和部署，生成代码库入门文档的技能。适合需要了解陌生项目的团队或 Agent，可将结果整理到 `ONBOARDING.md` 或指定位置。

主要功能

  1. 01并行探索代码库的五个领域
  2. 02梳理项目结构和关键配置
  3. 03识别数据模型、路由与身份验证
  4. 04检查部署方式和本地设置
  5. 05综合结果生成入门文档

适用场景

  1. 01帮助新成员熟悉代码仓库
  2. 02记录陌生的 monorepo
  3. 03准备本地开发设置指南

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/spencerpauly/awesome-cursor-skills --skill codebase-onboarding

安装后在 Claude Code 中输入/codebase-onboarding确认已加载。

详细介绍

代码库入门指南

通过并行探索代码库，生成一份全面的入门文档。

工作流

1. 启动并行探索器

启动 5 个 explore 子 Agent，分别调查不同领域：

Agent 1 — 架构与结构

“梳理顶层目录结构。确定使用的框架（Next.js、Express、Django 等）、单体仓库工具（turbo、nx）和关键配置文件。列出每个应用/软件包及其用途。”

Agent 2 — 数据模型与数据库

“查找所有数据库架构、ORM 模型、迁移文件和种子文件。列出每个实体、其字段和关系。确定使用的数据库（Postgres、MySQL、MongoDB 等）和 ORM（Prisma、Drizzle、SQLAlchemy 等）。”

Agent 3 — API 路由与端点

“查找所有 API 路由定义。列出每个端点的 HTTP 方法、路径、身份验证要求和用途。确定使用的 API 风格（REST、GraphQL、tRPC）。”

Agent 4 — 身份验证与授权

“查找身份验证的工作方式。确定身份验证提供方（Auth.js、Clerk、Supabase Auth、自定义实现）、会话管理、受保护路由、角色/权限检查和中间件。”

Agent 5 — 部署与基础设施

“查找部署配置（Dockerfile、Vercel config、fly.toml、terraform）、CI/CD 流水线（GitHub Actions 等）、所需环境变量，以及在本地运行应用的方法。”

2. 综合整理

将全部 5 个 Agent 的结果整合为一份入门文档：

# Codebase Onboarding

## Quick Start
1. Clone the repo
2. Install dependencies: `<command>`
3. Set up environment: copy `.env.example` to `.env`
4. Run database migrations: `<command>`
5. Start dev server: `<command>`

## Architecture
<Agent 1 findings>

## Data Models
<Agent 2 findings>

## API Reference
<Agent 3 findings>

## Authentication
<Agent 4 findings>

## Deployment
<Agent 5 findings>

## Key Files to Know
- `<file>` — <why it matters>
3. 保存

将文档写入项目根目录下的 ONBOARDING.md，或写入用户指定的位置。

提示

  • 每个 explore Agent 都是只读且速度很快，整个过程不到一分钟
  • 对于单体仓库，可以考虑为每个应用/软件包额外安排一个 Agent
  • 文档应包含明确建议：重点指出“从这里开始”的文件，而不是只罗列所有内容
  • 包含注意事项：常见的设置问题、容易遗漏的环境变量、必需的系统依赖

评论

支持 Markdown