/start - 项目快速了解
新成员快速了解项目的必看命令。自动检测项目类型、扫描业务模块、生成项目概览。
🎯 适用场景
场景 说明
初次接触 新成员第一次接触项目
项目交接 接手他人的项目
重新梳理 距上次熟悉项目已久,需要快速回顾
窗口切换 在新的会话中快速了解项目
🚀 执行流程
第一步:识别项目类型和框架(强制执行)
扫描项目结构
Glob pattern: "ruoyi-modules/ruoyi-*/src/main/java/**/controller/*Controller.java"
查看最近 3 条 Git 提交
git log -3 --oneline --format="%h %s (%ar)"
识别框架模块(不统计进度):
-
✅ ruoyi-system
-
系统管理模块
-
✅ ruoyi-generator
-
代码生成器
-
✅ ruoyi-common
-
通用工具库
识别业务模块(需统计进度):
- 排除上述框架模块后的所有 ruoyi-* 模块
第二步:判断项目开发阶段
业务模块数量 = 0 → 🟢 全新项目(仅有框架) 业务模块数量 1-5 → 🟡 初期开发(刚开始业务) 业务模块数量 6+ → 🔴 成熟项目(业务较多)
第三步:生成项目概览报告
情况 1:全新项目(业务模块数 = 0)
👋 欢迎使用 RuoYi-Vue-Plus 框架
项目类型:Spring Boot 3 + MyBatis-Plus 纯后端项目 框架版本:5.5.3+
📦 框架现状
✅ 已就绪的框架模块
| 模块 | 说明 | 状态 |
|---|---|---|
| ruoyi-system | 系统管理(用户、角色、菜单、字典等) | ✅ 完整 |
| ruoyi-generator | 动态代码生成器 | ✅ 完整 |
| ruoyi-common | 通用工具库 | ✅ 完整 |
🎯 快速开始
方式 1:使用 /dev 命令(推荐)
`/dev`
方式 2:使用 /crud 命令(表已存在)
`/crud`
💡 推荐操作
第一步:了解项目规范 查看项目根目录的 CLAUDE.md 文件
第二步:初始化项目文档 `/init-docs`
第三步:开发第一个功能 `/dev` 或 `/crud`
情况 2:初期开发项目(业务模块数 1-5)
👋 欢迎回到项目
技术栈:Spring Boot 3 + MyBatis-Plus + Sa-Token 项目阶段:🟡 初期开发
📊 项目概况
业务进度
- 业务模块:X 个
- 已完成功能:X 个
- 进行中功能:X 个
- 总体进度:X%
🎯 当前工作建议
快速查看进度
`/progress`
检查代码规范
`/check`
获取开发建议
`/next`
📚 相关命令
命令 说明 用途
/progress
详细进度报告 了解各模块完成情况
/check
代码规范检查 确保代码质量
/next
下一步建议 获取开发方向
/sync
全量同步 定期整理文档
/dev
开发新功能 完整开发流程
/crud
快速生成 表已存在时
🎓 新成员入门清单
-
阅读项目根目录的 CLAUDE.md 了解开发规范
-
运行 /start 了解项目现状
-
运行 /progress 查看详细进度
-
查看 /docs/ARCHITECTURE.md 了解架构
-
根据 /next 建议选择任务
-
使用 /dev 或 /crud 开始开发