sopaco/deepwiki-rs

Litho (deepwiki‑rs) – 用 Rust 编写的 AI 驱动文档生成器

它能做什么 – Litho 扫描整个源代码仓库，提取结构、注释和依赖关系，然后使用 LLM 将这些原始信息转换为 C4 模型（上下文、容器、组件、代码图）的完整架构文档。输出是一个可直接阅读的 Wiki，与代码保持同步。

为何重要 – 保持技术文档的最新状态是开发者的长期痛点。Litho 自动化了整个流程，使团队能减少编写 Markdown 的时间，更多地专注于编码。由于它以 Rust 二进制文件运行，因此速度快，可轻松集成到 CI/CD 流水线中。

主要功能（README 中所述）

• 四阶段流水线 – 预处理（代码发现与解析）、研究（LLM 驱动的架构推断）、文档生成（C4 图、Markdown）、验证/增强（Mermaid 语法修复、完整性检查）。
• 多语言支持 – 支持 Rust、Python、Java、Go、C#、JavaScript 等多种语言。
• 外部知识集成 – 可挂载额外文档（PDF、Markdown、SQL）以丰富分析内容。
• 数据库文档 – 自动为 SQL 项目生成 ER 图。
• Git 历史分析 – 跟踪架构随时间的演变过程。
• CI/CD 就绪 – 可在每次提交时调用，保持文档新鲜。
• 生态系统工具 –
  • Litho Book：支持 Mermaid 的 Rust/Axum Markdown 查看器，具备 AI 驱动的问答功能。
  • Mermaid Fixer：AI 辅助工具，扫描 Markdown 中损坏的 Mermaid 图并修复它们。

工作原理（流水线概览）

1. 预处理 – 代码扫描器发现文件，解析语法，提取注释，并构建依赖图。
2. 研究 – 专用 AI 代理（系统上下文研究员、领域模块检测器、工作流研究员等）运行 ReAct 推理循环，推断架构意图并生成中间报告。
3. 文档生成 – 编辑器将 C4 模型图、概览页、模块级文档和交叉引用组合成层次化的 Markdown 树。
4. 验证与增强 – 验证/修复 Mermaid 语法，运行完整性检查，并输出最终质量报告。

典型工作流程

# 安装 crate
cargo install deepwiki-rs

# 在仓库上运行 Litho（示例）
litho generate --repo /path/to/project --output docs/

该命令生成一个包含 Markdown 文件和 Mermaid 图的目录，可直接提供服务，或使用 Litho Book 打开以获得更佳的用户界面。

谁应该使用它

• 希望获得自动化、最新架构文档的开发团队。
• 寻找低维护成本 Wiki 的开源维护者。
• 需要合规性审计文档的企业。

相关项目 – README 指出，Litho 已被更新的项目 Terrain 取代，该工具为 AI 代理添加了代码库的动态地图，同时保留 Litho 作为快速 C4 文档生成器。

---

以上所有细节均直接来自仓库的 README；未推断任何额外功能。