用途:为代码库生成分层、带源码链接和图表的 Wiki,帮助开发者理解仓库、生成架构文档或完成新人上手。
主要能力:分析脚本 scripts/analyze.py 自动执行文件发现、语言统计、清单解析、框架检测、基于 tree-sitter 的代码结构提取、基于 networkx 的 PageRank 重要性排序,以及 Git 热点与归属分析,输出 JSON 报告。文档按四阶段流程生成:侦察、架构映射、深度文档、组装。每页包含 TL;DR、相关源文件、架构图、关键概念表、带引用的正文、交叉引用和活跃开发区域。
使用方式:先安装依赖 pip install -r scripts/requirements.txt,再运行 python scripts/analyze.py <repo_path> --output codebase-analysis.json,阅读 JSON 报告后按模板撰写页面。输出可为 wiki/ 目录下的编号 .md 文件、单一合并文档或对话式讲解。
适用场景:仓库理解、架构文档、开发者入职、代码库映射。
限制:所有依赖可选,缺失时降级;无 tree-sitter 则无代码结构数据,无 networkx 则无重要性排序,无 git 则无 Git 洞察。无法验证的结论需标记 [NEEDS INVESTIGATION]。Mermaid 仅输出源码,渲染由查看器负责。具体收费与平台信息暂未提供。