AI 架构文档生成器sopaco/deepwiki-rs

Litho (deepwiki-rs)

💪🏻 使用 Rust 构建的高性能 AI 驱动智能文档生成器（类似 DeepWiki）
📚 为任意代码库自动生成高质量的 Repo-Wiki

🚀 Litho 已演进为 Terrain —— 为你的 AI 智能体提供代码库的实时地图。

基于 Litho：知识库与代码保持同步 · 更广泛的语言与框架支持 · 主流智能体（Claude Code、Codex、DeepSeek Harness……）通过 ACP 读取 · 内置 Litho Book。

查看 Terrain →  ·  Litho 仍是快速、专注的 C4 文档生成器。

👋 Litho 是什么
Litho 是一个由 AI 驱动的文档生成引擎，可自动分析你的源代码，并以 C4 模型格式生成全面、专业的架构文档。不再需要那些总是落后于代码变更的手动文档——Litho 让你的文档与代码库保持完美同步。

Litho 将原始代码转化为结构精美的文档，包括上下文图、容器图、组件图和代码级文档——所有这些都从你的源代码自动生成。

无论你是开发者、架构师还是技术负责人，Litho 都能消除维护文档的负担，并确保你的团队始终拥有准确、最新的架构信息。

在几分钟内将你的代码库转化为专业的架构文档

使用 Litho 之前
使用 Litho 之后

手动文档

过时、不完整或缺失的文档
手动更新总是落后于代码变更
格式和结构不一致
维护耗时
难以浏览和理解
通常只有几个 markdown 文件

AI 生成的文档

从代码库自动生成
始终与代码变更保持同步
专业的 C4 模型结构
一致的格式和样式
易于浏览和理解
包含图表、上下文和关系的完整内容

🚀 Litho 自动将你混乱的代码库转化为精美、专业的文档

😺 为什么使用 Litho

- 自动让文档与代码库变更保持同步——不再有过时的文档
- 节省数百小时用于手动创建和维护文档的时间
- 为新团队成员改进入职体验，提供全面且最新的文档
- 通过提供清晰的架构上下文来增强代码审查
- 通过可审计的自动化文档满足合规要求
- 支持多种编程语言（Rust、Python、Java、Go、C#、JavaScript 等）
- 生成专业的 C4 模型图，包括上下文、容器、组件和代码
- 与 CI/CD 流水线集成，在每次提交时自动生成文档

🌟 适用于：
- 各种规模的开发团队
- 开源项目
- 企业软件开发者
- 任何讨厌维护过时文档的人！

❤️ 喜欢 Litho？给它点个星 🌟 或 赞助我！❤️

感谢这些善良的人们

@sopaco/deepwiki-rs 的 Stargazers 仓库名单

🌠 功能与能力

核心能力
- 基于代码库分析的 AI 驱动架构文档生成
- 自动创建 C4 模型图（上下文、容器、组件、代码）
- 智能提取代码注释、结构和关系
- 支持多种编程语言
- 可自定义的文档输出模板系统

高级功能
- 外部知识集成 - 将外部文档（PDF、Markdown、SQL 等）挂载为知识源，以增强分析
- 数据库文档 - 为 SQL 项目自动生成数据库模式文档及 ERD 图
- Git 历史分析，用于跟踪架构演变
- 代码元素与文档之间的交叉引用
- 包含嵌入式图表和示例的交互式文档
- 与 CI/CD 流水线集成，实现自动化文档生成

💡 解决的问题
Litho 通过从源代码自动生成最新的架构文档，解决了技术文档过时和不完整的常见问题。不再需要会落后于代码变更的手动文档——Litho 让你的文档与代码库保持同步。

🌐 Litho 生态系统
Litho 是更广泛工具生态系统的一部分，旨在提升开发者生产力和文档质量。Litho 生态系统包含与 Litho 无缝协作的补充工具，提供完整的文档工作流：

📘 Litho Book
Litho Book 是一个使用 Rust 和 Axum 构建的高性能 Markdown 阅读器，专为浏览 Litho 生成的文档提供优雅界面而设计。

主要功能
- 实时 Markdown 渲染与语法高亮
- 完整支持 Mermaid 图表，用于架构图
- 智能搜索，支持文件和内容的模糊匹配
- 高性能架构，低内存占用
- AI 智能文档解读与问题解答

🌠 快照

与 Litho 集成
Litho Book 是用于阅读 Litho 生成文档的理想配套应用。典型工作流程如下：
1. 使用 Litho 从你的代码库生成文档
2. 使用 Litho Book 通过优雅的界面浏览和探索生成的文档

进一步了解 Litho Book

🔧 Mermaid Fixer
Mermaid Fixer 是一款高性能的 AI 驱动工具，可自动检测并修复 Markdown 文件中 Mermaid 图表的语法错误。

主要特性
- 自动扫描目录中的 Markdown 文件
- 使用 JS 沙箱验证精确检测 Mermaid 语法错误
- 通过 LLM 集成实现 AI 驱动的智能修复
- 全面报告修改前后的变化
- 灵活配置，支持多种 LLM 提供商

与 Litho 集成
Mermaid Fixer 通过自动修复 Mermaid 图表中的语法错误，提升 Litho 生成文档的质量。这确保你文档中的所有架构图都有效并能正确渲染。

👀 快照

进一步了解 Mermaid Fixer

🤖Agent Skills
在 Smithery 中运行！ Run in Smithery

🧠 工作原理
zread

四阶段处理流水线
Litho 的架构围绕一个四阶段处理流水线设计，将原始代码转化为全面的文档：

flowchart TD
A[Input: Source Code Repository] --> B[Phase 1: Preprocessing]
B --> C[Phase 2: Intelligent Research & Analysis]
C --> D[Phase 3: Documentation Generation]
D --> E[Phase 4: Verification & Enhancement]
E --> F[Output: High-Quality Technical Documentation]

subgraph Preprocessing Phase
B1[Code Scanning & Discovery]
B2[Multi-Language Syntax Analysis]
B3[Structure & Dependency Extraction]
B4[Code Insight Generation]
B5[Agent Memory Chunk Initialization]
B --> B1 --> B2 --> B3 --> B4 --> B5
end

subgraph Intelligent Research & Analysis Phase
C1[System Context Researcher]
C2[Domain Module Detector]
C3[Workflow Researcher]
C4[Boundary Analyzer]
C5[Key Module Insight Officer]
C6[Agent Memory Chunk Read/Write]
C7[ReAct Reasoning Loop]
C --> C1 --> C2 --> C3 --> C4 --> C5 --> C6 --> C7
end

subgraph Documentation Generation Phase
D1[Overview Documentation Editor]
D2[Architecture Documentation Editor]
D3[Workflow Documentation Editor]
D4[Boundary Documentation Editor]
D5[Key Module Editor]
D6[Agent Memory Chunk Reading]
D7[High-Quality Documentation Assembly]
D --> D1 --> D2 --> D3 --> D4 --> D5 --> D6 --> D7
end

subgraph 验证与增强阶段
E1[Mermaid 语法验证]
E2[文档完整性检查]
E3[图表自动修复]
E4[质量报告生成]
E5[最终文档输出]
E --> E1 --> E2 --> E3 --> E4 --> E5
end

style B fill:#e3f2fd,stroke:#1976d2
style C fill:#f3e5f5,stroke:#7b1fa2
style D fill:#e8f5e8,stroke:#388e3c
style E fill:#fff3e0,stroke:#e65100

预处理阶段
Litho 首先扫描你的整个代码库，以识别源文件、提取元数据并分析项目结构。此阶段：
- 发现跨多种语言的所有源代码文件
- 解析文件结构并识别关键组件
- 提取注释、文档字符串和代码注解
- 识别模块与组件之间的依赖关系
- 构建代码库的全面表示

flowchart TD
A[预处理代理] --> B[结构提取器]
A --> C[原始文档提取器]
A --> D[代码分析代理]
A --> E[关系分析代理]
B --> F[项目结构]
C --> G[原始文档材料]
D --> H[核心代码洞察]
E --> I[代码依赖关系]
F --> J[存储到内存]
G --> J
H --> J
I --> J

研究阶段
在这个由 AI 驱动的阶段，Litho 分析代码结构以理解架构意图：
- 应用机器学习模型来识别模式和关系
- 从代码结构和命名约定推断架构角色
- 确定组件边界和服务职责
- 映射组件之间的依赖关系和数据流
- 识别潜在的架构异味和反模式
- 为每个组件生成上下文感知的文档

flowchart TD
A[研究编排器] --> B[系统上下文研究员]
A --> C[领域模块检测器]
A --> D[架构研究员]
A --> E[工作流研究员]
A --> F[关键模块洞察]
B --> G[系统上下文报告]
C --> H[领域模块报告]
D --> I[架构分析报告]
E --> J[工作流分析报告]
F --> K[模块深度洞察]
G --> Memory
H --> Memory
I --> Memory
J --> Memory
K --> Memory

组合与输出阶段
Litho 将分析后的信息组合成结构化的文档格式：
- 生成 C4 模型图（上下文、容器、组件、代码）
- 创建具有清晰导航的层次化文档结构
- 嵌入相关代码示例和解释
- 在所有文档中应用一致的样式和格式
- 在相关组件和图表之间添加交叉引用

flowchart TD
A[文档组合器] --> B[概览编辑器]
A --> C[架构编辑器]
A --> D[模块洞察编辑器]
B --> E[概览文档]
C --> F[架构文档]
D --> G[模块文档]
E --> H[文档树]
F --> H
G --> H
H --> I[磁盘输出]
I --> J[输出目录]
验证与增强阶段
最终阶段确保文档质量和完整性：
- 验证图表语法和一致性
- 检查文档覆盖的完整性
- 识别文档中的缺口并提出改进建议
- 与 Mermaid Fixer 集成，确保所有图表正确渲染
- 生成文档覆盖率的统计数据和报告
- 创建索引和目录以便于导航

🏗️ 架构概览

Litho 采用精心设计的模块化架构，旨在实现高性能、可扩展性和智能分析。该系统实现了多阶段工作流，配备专门的 AI 代理和全面的缓存机制。

graph LR
subgraph Input Phase
A[CLI Startup] --> B[Load Configuration]
B --> C[Scan Structure]
C --> D[Extract README]
end
subgraph Analysis Phase
D --> E[Language Parsing]
E --> F[AI-Enhanced Analysis]
F --> G[Store in Memory]
end
subgraph Reasoning Phase
G --> H[Orchestrator Startup]
H --> I[System Context Analysis]
H --> J[Domain Module Detection]
H --> K[Workflow Analysis]
H --> L[Key Module Insights]
I --> M[Store in Memory]
J --> M
K --> M
L --> M
end
subgraph Orchestration Phase
M --> N[Orchestration Hub Startup]
N --> O[Generate Project Overview]
N --> P[Generate Architecture Diagram]
N --> Q[Generate Workflow Documentation]
N --> R[Generate Module Insights]
O --> S[Write to DocTree]
P --> S
Q --> S
R --> S
end
subgraph Output Phase
S --> T[Persist Documents]
T --> U[Generate Summary Report]
end

核心模块
Litho 的架构由多个相互连接的模块组成，它们协同工作以实现无缝的文档生成：

- 代码扫描器：发现并分析多种语言的源代码文件
- 语言解析器：使用特定语言的解析器从代码中提取结构信息
- 架构分析器：AI 驱动的组件，用于推断架构模式和关系
- 图表生成器：使用 Mermaid 语法创建 C4 模型图
- 文档格式化器：将内容组织成结构化、可导航的文档

核心流程
核心处理流程遵循确定性管道：
1. 扫描 - 发现并分析源代码文件
2. 解析 - 提取结构和语义信息
3. 分析 - 应用 AI 模型推断架构和关系
4. 生成 - 创建图表和文档内容
5. 格式化 - 将内容组织成结构化文档
6. 导出 - 以所需格式输出

sequenceDiagram
participant Main as main.rs
participant Workflow as workflow.rs
participant Context as GeneratorContext
participant Preprocess as PreProcessAgent
participant Research as ResearchOrchestrator
participant Doc as DocumentationOrchestrator
participant Outlet as DiskOutlet
Main->>Workflow : launch(config)
Workflow->>Context : 创建上下文（LLM、Cache、Memory）
Workflow->>Preprocess : execute(context)
Preprocess->>Context : 存储项目结构和元数据
Context-->>Workflow : 预处理完成
Workflow->>Research : execute_research_pipeline(context)
Research->>Research : 并行执行多个研究代理
loop 每个研究代理
Research->>StepForwardAgent : execute(context)
StepForwardAgent->>Context : 验证数据源
StepForwardAgent->>AgentExecutor : 调用提示词或提取
AgentExecutor->>LLMClient : 发起 LLM 请求
LLMClient->>CacheManager : 检查缓存
alt 缓存命中
CacheManager-->>LLMClient : 返回缓存结果
else 缓存未命中
LLMClient->>LLM : 调用 LLM API
LLM-->>LLMClient : 返回原始响应
LLMClient->>CacheManager : 将结果存入缓存
end
LLMClient-->>AgentExecutor : 返回处理后的结果
AgentExecutor-->>StepForwardAgent : 返回结果
StepForwardAgent->>Context : 将结果存入 Memory
end
Research-->>Workflow : 研究完成
Workflow->>Doc : execute(context, doc_tree)
Doc->>Doc : 调用多个组合代理以生成文档
Doc-->>Workflow : 文档生成完成
Workflow->>Outlet : save(context)
Outlet-->>Workflow : 存储完成
Workflow-->>Main : 处理完成

🖥 快速开始
前置条件
- Rust（版本 1.70 或更高）
- Cargo

安装
选项 1：从 crates.io 安装（推荐）
cargo install deepwiki-rs

选项 2：从源码构建
1. 克隆仓库：
git clone https://github.com/sopaco/deepwiki-rs.git

2. 进入项目目录：
cd deepwiki-rs

3. 构建项目：
cargo build --release

4. 编译后的二进制文件将位于 target/release 目录中。

🚀 使用方法
Litho 提供了一个简单的命令行界面，用于从你的代码库生成文档。有关更多配置参数，请参阅 CLI 选项详情。

基本命令
deepwiki-rs -p ./my-project -o ./docs

以目标语言生成文档。
deepwiki-rs --target-language en -p ./my-project

deepwiki-rs --target-language ja -p ./my-project

此命令将：
- 扫描 ./my-project 中的所有文件
- 分析代码结构和关系
- 生成全面的 C4 架构文档
- 将输出保存到 ./litho.docs 目录

文档生成
Litho 支持多种用于生成文档的选项：

使用默认设置生成文档
deepwiki-rs skip certain processing stages in the generation workflow
deepwiki-rs --skip-preprocessing --skip-research

高级选项
关闭 ReAct 模式，以避免通过工具调用自动扫描项目文件
deepwiki-rs -p ./src --disable-preset-tools --llm-api-base-url  --llm-api-key  --model-efficient GPT-5-mini

同时设置高效模型和强大模型
deepwiki-rs -p ./src --model-efficient GPT-5-mini --model-poweruful GPT-5-Pro --llm-api-base-url  --llm_api_key  --model-efficient GPT-5-mini

📚 外部知识集成

Litho 支持挂载外部文档作为知识源，以通过业务上下文和架构决策增强生成的文档。

支持的文档类型
- PDF - 架构图、设计文档
- Markdown - 技术文档、ADR
- SQL - 数据库模式文件
- YAML/JSON - API 规范（OpenAPI）、配置
- Text - 纯文本文档

知识类别
文档被组织到不同类别中，以便有针对性地交付给特定代理：
- architecture - 系统架构和 C4 模型文档
- database - 模式、ERD 和数据模型文档
- api - API 规范和端点文档
- deployment - 基础设施和 DevOps 文档
- adr - 架构决策记录
- workflow - 业务流程和工作流
- general - 未分类的通用文档

同步知识命令
同步外部知识源（处理并缓存本地文档）
deepwiki-rs sync-knowledge

即使缓存是新的也强制同步
deepwiki-rs sync-knowledge --force

配置示例（litho.toml）
[knowledge.local_docs]
enabled = true
cache_dir = ".litho/cache/knowledge/local_docs"
watch_for_changes = true

大型文档的默认分块
[knowledge.local_docs.default_chunking]
enabled = true
max_chunk_size = 8000
chunk_overlap = 200
strategy = "semantic"  # 选项：semantic、paragraph、fixed
min_size_for_chunking = 10000

架构文档类别
[[knowledge.local_docs.categories]]
name = "architecture"
description = "系统架构文档"
paths = [
"docs/architecture//.md",
"docs/design//.pdf"
]
target_agents = [
"SystemContextResearcher",
"ArchitectureResearcher",
"ArchitectureEditor"
]

数据库文档类别
[[knowledge.local_docs.categories]]
name = "database"
description = "数据库模式文档"
paths = [
"docs/database//.md",
"docs/schema//.sql"
]
target_agents = [
"ArchitectureResearcher",
"DomainModulesDetector",
"KeyModulesInsight"
]

🗄️ 数据库文档

Litho 会自动分析 SQL 数据库项目（.sqlproj）和 SQL 文件，以生成全面的数据库文档，包括：

- 数据库项目 - SQL Server 项目结构
- 表 - 架构、列、数据类型、约束、主键
- 视图 - 视图定义和引用的表
- 存储过程 - 参数、操作、访问的表
- 函数 - 标量函数和表值函数
- 关系 - 外键和隐式引用（附 ERD 图）
- 数据流 - ETL 操作和数据移动模式

数据库分析功能
📊 数据库代码分布：Projects(2) SQL Files(15) DAO(3)
✅ 数据库概览分析已完成：
- 数据库项目：2 项
- 表：12 项
- 视图：5 项
- 存储过程：8 项
- 函数：3 项
- 表关系：6 项
- 数据流：4 项
- 置信度：8.5/10

生成的数据库文档
数据库文档会自动包含在输出中，文件名为 6.Database-Overview.md，内容包括：
- 汇总统计表
- 详细的表架构及列定义
- 显示关系的 Mermaid ER 图
- 存储过程文档
- 数据流描述

📁 输出结构
Litho 生成组织良好的文档结构：

project-docs/
├── 1. Project Overview      # 项目概览、核心功能、技术栈
├── 2. Architecture Overview # 整体架构、核心模块、模块分解
├── 3. Workflow Overview     # 整体工作流、核心流程
├── 4. Deep Dive/            # 详细技术主题实现文档
│   ├── Topic1.md
│   ├── Topic2.md
├── 5. Boundary-Interfaces   # API 端点、外部集成
├── 6. Database-Overview     # 数据库架构、表、关系（仅限 SQL 项目）

🤝 贡献
我们欢迎各种形式的贡献！请通过 GitHub Issues 报告 bug 或提交功能请求。

贡献方式
- 语言支持：添加对其他编程语言的支持
- 模板创建：设计新的文档模板和样式
- 图表增强：改进 Mermaid 图表生成算法
- 性能优化：提升处理速度和内存使用效率
- 测试覆盖：为各种代码模式添加全面的测试用例
- 文档：改进项目文档和使用指南
- Bug 修复：帮助识别和修复代码库中的问题

开发贡献流程
1. Fork 本项目
2. 创建功能分支（git checkout -b feature/amazing-feature）
3. 提交你的更改（git commit -m 'Add some amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 创建 Pull Request

🪪 许可证
MIT。许可证副本见 LICENSE 文件。

👨 关于我
🚀 通过 在 GitHub 上赞助 帮助我更好地开发这个软件
一位经验丰富的互联网老兵，历经PC互联网、移动互联网和AI应用的浪潮。从个人移动应用开发者到企业界的专业人士，我在产品设计与研发方面拥有丰富经验。目前就职于快手，专注于通用前端系统的研发与AI探索。

GitHub：sopaco

常见问题

什么是 Litho（deepwiki-rs）？

Litho 是一个基于 Rust 构建的 AI 驱动文档生成引擎。它能够自动分析你的源代码，并以 C4 模型格式生成全面、专业的架构文档。

Litho 支持哪些编程语言？

Litho 支持多种编程语言，包括 Rust、Python、Java、Go、C#、JavaScript 等。

什么是 C4 模型？

C4 模型是一种软件架构文档方法，包含四个层级：
- 上下文图（系统上下文）
- 容器图（系统容器）
- 组件图（容器组件）
- 代码图（组件实现）

如何安装 Litho？

cargo install deepwiki-rs

或从源码构建：

git clone https://github.com/sopaco/deepwiki-rs
cargo build --release

Litho 能否与 CI/CD 集成？

可以，Litho 能够与 CI/CD 流水线集成，在每次提交时自动生成文档。

为什么使用 Litho 而不是手动编写文档？

- 自动保持文档与代码库同步
- 节省数百小时的手动维护时间
- 专业的 C4 模型结构
- 一致的格式与样式
- 易于浏览和理解

在哪里可以获得帮助？

- 文档：https://github.com/sopaco/deepwiki-rs/tree/main/docs
- GitHub Issues：https://github.com/sopaco/deepwiki-rs/issues