deepwiki-rs

Litho (deepwiki-rs) 是一个以 Rust 编写的高性能文档生成工具，旨在解决代码库与技术文档长期脱节的问题。它作为一个自主代理，通过解析原始代码来自动建立动态技术文档，特别专注于 C4 架构模型（上下文、容器、组件、代码）。通过自动映射模块关系与系统设计，它使架构师、技术主管与开发者能够在无需手动维护 Markdown 文件的情况下，保持技术规格的准确性。

• 自动生成完整的 C4 架构图与项目总览文档。

• 支持多种编程语言，包含 Rust、Python、JavaScript、TypeScript、Go、Java 与 C#。

• 可直接整合至 CI/CD 流水线，确保每次 git push 或合并请求后文档自动同步。

• 提供深入的代码库分析，包括结构逻辑、设计决策与架构演进的提取。

• 提供可自定义的文档模板，以符合各团队的风格与专业标准。

• 支持挂载外部知识库（如 PDF、Markdown 或 SQL 数据库纲要）以增强分析上下文。

• 当您需要进行深度架构分析、准备新成员入职文档或撰写技术设计规格时，请调用此工具。

• 针对小型项目建议使用 --model-efficient 参数以获取快速扫描结果，大型微服务或单体项目建议使用 --model-powerful 进行详细映射。

• 输入为包含源码（如 /src 或 /lib）的项目根目录路径；默认输出为包含详细 Markdown 的 ./litho.docs 目录。

• 受限于所选 AI 模型的 API 速率限制，建议在处理大规模代码库时使用批处理机制。

• 非常适合解决手动文档维护导致效率低下，或是软件架构因开发速度过快而出现架构漂移（Architecture Drift）的团队。