SuperAPI AI 工具集

codebase-onboarding

办公与效率

查看项目

更新于 10-15 21:36

技能介绍

用途:为代码库生成层级化、带源码链接与图表的 Wiki,帮助开发者理解与上手项目。

主要能力:先运行分析脚本收集结构化数据,包括文件发现、语言统计、清单解析、框架检测、基于 AST 的代码结构、PageRank 重要性排序与 Git 洞察;再据此规划页面树、编写深度文档并组装输出。支持输出编号 .md 文件、单一合并文档或对话式讲解。

使用方式:仓库在本地时先执行 pip install -r scripts/requirements.txt(可选),再运行 python scripts/analyze.py <repo_path> --output /tmp/codebase-analysis.json,读取 JSON 报告后再撰写架构说明。所有技术论断需引用源文件,无法验证的标记为 [NEEDS INVESTIGATION]。

适用场景:新成员入职、架构文档生成、理解陌生仓库、映射代码库结构。

限制:依赖均为可选并支持优雅降级;缺少 tree-sitter 或 networkx 时结构分析与重要性排序受限,需手动侦察并说明局限。图表以 Mermaid 源码输出,渲染由查看器负责。具体收费与平台信息暂未提供。