agentleFS
Sign inStart free
liuxiao20051106-progliuxiao20051106-prog/claude-skills/project-onboarding/SKILL.md

project-onboarding

Skill1 starsChanged 3 months agoMITView on GitHub

新项目快速上手：自动分析代码库结构、技术栈、核心模块、代码约定，生成一份"10分钟速懂"摘要。用户说"新项目"、"快速上手"、"看懂项目"、"project overview"、"onboarding"、"项目结构"时触发。

  • Reads credentials
  • Installs packages

13 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use code-review.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 3 projects that use this

The file

Create a free account to mount
Files
SKILL.md

project-onboarding · 项目快速上手

拉下新仓库后，用最小阅读量生成一份"10 分钟速懂"项目地图。

流程

1. 扫描项目骨架

并行读取关键文件，一次性建立全局认知：

必读：
  CLAUDE.md / CONTRIBUTING.md / README.md
  package.json / Cargo.toml / go.mod / pyproject.toml / pom.xml
  .gitignore / .dockerignore

结构扫描：
  一级目录树（src/ | app/ | cmd/ | lib/ | tests/ | docs/）
  主要入口文件（index.ts / main.go / app.py / lib.rs）
  路由/模块表（router/ | pages/ | modules/）
  配置文件（.env.example | config/ | docker-compose.yml）
  测试目录结构与框架

代码风格：
  .eslintrc / .prettierrc / .editorconfig / biome.json
  tsconfig.json / Cargo.toml[fmt] / pyproject.toml[tool.ruff]

2. 生成摘要

# <项目名> · 10 分钟速懂

## 一句话定位
<这个项目做什么、给谁用>

## 技术栈
- 语言：TypeScript / Rust / Go / Python
- 框架：Next.js 14 / Gin / FastAPI / Actix
- 数据库：PostgreSQL + Redis
- 部署：Docker / K8s / Vercel

## 目录地图
src/
├── app/          ← 路由页面 (Next.js App Router)
├── components/   ← 共享 UI 组件
├── lib/          ← 工具函数 & API 封装
├── db/           ← 数据库 schema & migration
└── tests/        ← Vitest 单测 + Playwright E2E

## 核心模块
- **auth** (`src/lib/auth.ts`) — JWT 登录，middleware 保护路由
- **api** (`src/app/api/`) — RESTful，tRPC 类型安全
- **queue** (`src/workers/`) — BullMQ 异步任务

## 代码约定
- 文件名：kebab-case.tsx
- 组件：函数组件 + Hooks，不用 class
- 样式：Tailwind CSS，不用 CSS Modules
- 提交：Conventional Commits，pre-commit lint
- 测试：每个 feature 至少一个集成测试

## 快速开始
```bash
cp .env.example .env    # 填数据库连接
pnpm install
pnpm dev                # http://localhost:3000
pnpm test               # 运行测试

关键入口

文件看懂它
src/app/layout.tsx全局布局
src/lib/auth.ts认证逻辑
src/db/schema.ts数据模型
src/app/api/API 路由
prisma/schema.prisma数据库 schema

### 3. 内存持久化
生成摘要后，写入 `~/.claude/projects/<project-name>/memory/`，下次打开项目自动加载。

### 原则
- **并行读取**：所有文件一次性扫描，不串行等待
- **推断但不猜测**：技术栈从配置文件提取，不确定的标注 `[待确认]`
- **看 CLAUDE.md 优先**：如果已有，只补充未覆盖的部分
- **保持简洁**：每个模块一句话，不是长段落
- **只读**：不修改项目文件，只写摘要到 memory

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free