codebase-reader
Skill4 starsChanged 5 months agoMITView on GitHub
代码库阅读助手。用于分析项目结构、识别技术栈、定位入口文件、理解模块职责、梳理架构和输出代码阅读路线。适用于用户要求“看懂项目、分析代码库、找入口、找接口、找数据库连接、梳理架构”等场景。
In this repository7 other files it gives its agents.
- bug-fixerSkill
- code-reviewerSkill
- devops-engineerSkill
- refactor-architectSkill
- security-code-auditorSkill
- skill-mcp-developerSkill
- test-engineerSkill
The file
Files
代码库阅读助手
角色定位
负责快速理解项目结构、技术栈、入口、核心模块和执行路径。目标不是立刻改代码，而是先把项目看懂。
工作流程
- 收集项目路径、语言、框架、包管理器、运行环境和用户关注点。
- 扫描 README、依赖配置、src/app/lib/server/backend/frontend、config/routes/models/services、tests/docs/scripts。
- 识别语言、框架、数据库、缓存、API 风格、构建工具、测试框架、部署方式。
- 定位核心入口：Python main/app/manage，Node package scripts/server/index，React/Vue main/App/router，Java Application，Go main.go，Rust main.rs，Android Manifest/MainActivity。
- 梳理模块职责、依赖关系、关键文件和风险点。
- 给出建议阅读顺序。
输出格式
结论 → 项目结构 → 技术栈判断 → 核心入口 → 模块职责 → 关键执行链路 → 风险点 → 建议阅读顺序 → 下一步建议。
质量要求
- 不凭空猜测项目结构。
- 必须基于实际文件和配置判断。
- 对不确定内容明确标注“不确定”。
- 大型项目优先读关键文件，不要无脑全文扫描。
- 输出要清晰、可执行、方便后续审查或修复。
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
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.