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

Litho (deepwiki-rs)

💪🏻 高性能 AI 驱动的智能文档生成器（类 DeepWiki），用 Rust 打造 📚 为任何代码库自动生成高质量 Repo-Wiki

🚀 Litho 已进化为 Terrain —— 给你的 AI 智能体一张会呼吸的代码库地图。

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

去看看 Terrain → · Litho 依然是那个快而专注的 C4 文档生成器。

👋 Litho 是什么

Litho 是 AI 驱动的文档生成引擎，自动分析你的源代码，按 C4 模型格式生成全面、专业的架构文档。不用再手写文档、追着代码改动跑——Litho 让文档与代码库始终保持同步。

Litho 把原始代码变成结构漂亮的文档，包含上下文图、容器图、组件图和代码级文档——全部从源代码自动生成。

无论你是开发者、架构师还是技术负责人，Litho 都能免去维护文档的负担，让团队始终拿到准确、最新的架构信息。

几分钟内把代码库变成专业的架构文档

Before Litho
After Litho

Manual Documentation

Outdated, incomplete, or missing documentation
Manual updates that fall behind code changes
Inconsistent formatting and structure
Time-consuming to maintain
Hard to navigate and understand
Usually just a few markdown files

AI-Generated Documentation

Automatically generated from codebase
Always up-to-date with code changes
Professional C4 model structure
Consistent formatting and styling
Easy to navigate and understand
Complete with diagrams, context, and relationships

🚀 Litho 自动把你的乱糟糟代码库变成漂亮、专业的文档

😺 为什么用 Litho

- 文档自动跟代码库改动保持同步——不再有过时文档
- 省下几百小时手写和维护文档的时间
- 改进新成员上手体验：提供全面、最新的文档
- 提升代码评审质量：给出清晰的架构上下文
- 满足合规要求：文档可审计、自动化生成
- 支持多种编程语言（Rust、Python、Java、Go、C#、JavaScript 等）
- 生成专业的 C4 模型图：涵盖上下文、容器、组件和代码
- 集成 CI/CD 流水线：每次提交都自动生成文档

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

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

感谢这些热心人

Stargazers repo roster for @sopaco/deepwiki-rs

🌠 功能与能力

核心能力

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

高级功能

- 外部知识集成 - 挂载外部文档（PDF、Markdown、SQL 等）作为知识来源，增强分析能力
- 数据库文档 - 为 SQL 项目自动生成数据库 schema 文档，附带 ERD 图
- Git 历史分析，追踪架构演进
- 代码元素与文档之间交叉引用
- 交互式文档，内嵌图表和示例
- 集成 CI/CD 流水线，自动生成文档

💡 解决的问题

Litho 解决了一个常见问题：技术文档过时、不完整。它从源代码自动生成最新的架构文档。不用再手动维护文档，结果却总是落后于代码变更——Litho 让文档与代码库保持同步。

🌐 Litho 生态体系

Litho 属于一个更大的工具生态，这些工具旨在提升开发者生产力和文档质量。Litho 生态体系包含一些互补工具，它们与 Litho 无缝协作，提供完整的文档工作流：

📘 Litho Book

Litho Book 是一款高性能 markdown 阅读器，用 Rust 和 Axum 构建，专门为浏览 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

🧠 工作原理

四阶段处理流水线

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 Verification & Enhancement Phase
E1[Mermaid Syntax Verification]
E2[Documentation Integrity Check]
E3[Diagram Auto-Repair]
E4[Quality Report Generation]
E5[Final Documentation Output]
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[Preprocessing Agent] --> B[Structure Extractor]
A --> C[Original Document Extractor]
A --> D[Code Analysis Agent]
A --> E[Relationship Analysis Agent]
B --> F[Project Structure]
C --> G[Original Document Materials]
D --> H[Core Code Insights]
E --> I[Code Dependencies]
F --> J[Store to Memory]
G --> J
H --> J
I --> J

研究阶段

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

flowchart TD
A[Research Orchestrator] --> B[SystemContext Researcher]
A --> C[Domain Module Detector]
A --> D[Architecture Researcher]
A --> E[Workflow Researcher]
A --> F[Key Module Insights]
B --> G[System Context Report]
C --> H[Domain Module Report]
D --> I[Architecture Analysis Report]
E --> J[Workflow Analysis Report]
F --> K[Module Deep Insights]
G --> Memory
H --> Memory
I --> Memory
J --> Memory
K --> Memory

组合与输出阶段

Litho 把分析得到的信息组合成结构化的文档格式：
- 生成 C4 模型图（Context、Container、Component、Code）
- 创建带清晰导航的层级化文档结构
- 嵌入相关代码示例和说明
- 为所有文档应用一致的样式和格式
- 在相关组件与图之间添加交叉引用

flowchart TD
A[Document Composer] --> B[Overview Editor]
A --> C[Architecture Editor]
A --> D[Module Insight Editor]
B --> E[Overview Document]
C --> F[Architecture Document]
D --> G[Module Documents]
E --> H[Document Tree]
F --> H
G --> H
H --> I[Disk Outlet]
I --> J[Output Directory]

验证与增强阶段

最后一个阶段确保文档质量与完整性：
- 校验图表语法与一致性
- 检查文档覆盖是否完整
- 找出文档缺口并给出改进建议
- 接入 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 的架构由多个相互连接的模块组成，它们协同工作，实现顺畅的文档生成：

- Code Scanner：发现并分析多种语言的源代码文件
- Language Parser：用各语言专属的解析器提取代码结构信息
- Architecture Analyzer：AI 驱动的组件，推断架构模式与模块关系
- Diagram Generator：用 Mermaid 语法生成 C4 模型图
- Documentation Formatter：把内容组织成结构清晰、便于导航的文档

核心流程

核心处理流程是一条确定性的流水线：
1. Scan - 发现并分析源代码文件
2. Parse - 提取结构与语义信息
3. Analyze - 应用 AI 模型推断架构与关系
4. Generate - 生成图表与文档内容
5. Format - 把内容组织成结构清晰的文档
6. Export - 按所需格式输出

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 : Create context (LLM, Cache, Memory)
Workflow->>Preprocess : execute(context)
Preprocess->>Context : Store project structure and metadata
Context-->>Workflow : Preprocessing complete
Workflow->>Research : execute_research_pipeline(context)
Research->>Research : Execute multiple research agents in parallel
loop Each Research Agent
Research->>StepForwardAgent : execute(context)
StepForwardAgent->>Context : Validate data sources
StepForwardAgent->>AgentExecutor : Call prompt or extract
AgentExecutor->>LLMClient : Initiate LLM request
LLMClient->>CacheManager : Check cache
alt Cache hit
CacheManager-->>LLMClient : Return cached result
else Cache miss
LLMClient->>LLM : Call LLM API
LLM-->>LLMClient : Return raw response
LLMClient->>CacheManager : Store result to cache
end
LLMClient-->>AgentExecutor : Return processed result
AgentExecutor-->>StepForwardAgent : Return result
StepForwardAgent->>Context : Store result to Memory
end
Research-->>Workflow : Research complete
Workflow->>Doc : execute(context, doc_tree)
Doc->>Doc : Call multiple composition agents to generate docs
Doc-->>Workflow : Documentation generation complete
Workflow->>Outlet : save(context)
Outlet-->>Workflow : Storage complete
Workflow-->>Main : Process finished

🖥 快速上手

前置条件

- 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 Options Detail。

基本命令

deepwiki-rs -p ./my-project -o ./docs

Generate documentation in the target language.
deepwiki-rs --target-language en -p ./my-project

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

这条命令会：
- 扫描 ./my-project 里的所有文件
- 分析代码结构和依赖关系
- 生成完整的 C4 架构文档
- 把输出保存到 ./litho.docs 目录

生成文档

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

Generate documentation with default settings
deepwiki-rs skip certain processing stages in the generation workflowsh
deepwiki-rs --skip-preprocessing --skip-research

高级选项sh

关闭 ReAct 模式，避免通过工具调用自动扫描项目文件

deepwiki-rs -p ./src --disable-preset-tools --llm-api-base-url <your llm provider base-api> --llm-api-key <your 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 <your llm provider base-api> --llm_api_key <your api key> --model-efficient GPT-5-mini

📚 外部知识集成

Litho 支持挂载外部文档作为知识来源，为生成的文档补充业务背景和架构决策。

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

知识分类文档按分类组织，以便精准投递给特定智能体：
- architecture - 系统架构与 C4 模型文档
- database - schema、ERD 与数据模型文档
- api - API 规范与端点文档
- deployment - 基础设施与 DevOps 文档
- adr - 架构决策记录
- workflow - 业务流程与工作流
- general - 未分类的通用文档

同步知识命令sh

同步外部知识来源（处理并缓存本地文档）

deepwiki-rs sync-knowledge

即使缓存是新的也强制同步

deepwiki-rs sync-knowledge --force

配置示例（litho.toml）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" # Options: semantic, paragraph, fixed
min_size_for_chunking = 10000

架构文档分类

[[knowledge.local_docs.categories]]
name = "architecture"
description = "System architecture documentation"
paths = [
"docs/architecture//.md",
"docs/design//.pdf"
]
target_agents = [
"SystemContextResearcher",
"ArchitectureResearcher",
"ArchitectureEditor"
]

数据库文档分类

[[knowledge.local_docs.categories]]
name = "database"
description = "Database schema documentation"
paths = [
"docs/database//.md",
"docs/schema//.sql"
]
target_agents = [
"ArchitectureResearcher",
"DomainModulesDetector",
"KeyModulesInsight"
]

🗄️ 数据库文档

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

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

数据库分析功能 📊 Database code distribution: Projects(2) SQL Files(15) DAO(3) ✅ Database overview analysis completed:
- Database projects: 2 items
- Tables: 12 items
- Views: 5 items
- Stored procedures: 8 items
- Functions: 3 items
- Table relationships: 6 items
- Data flows: 4 items
- Confidence: 8.5/10

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

📁 输出结构 Litho 生成结构清晰的文档：

project-docs/
├── 1. Project Overview # Project overview, core functionality, technology stack
├── 2. Architecture Overview # Overall architecture, core modules, module breakdown
├── 3. Workflow Overview # Overall workflow, core processes
├── 4. Deep Dive/ # Detailed technical topic implementation documentation
│ ├── Topic1.md
│ ├── Topic2.md
├── 5. Boundary-Interfaces # API endpoints, external integrations
├── 6. Database-Overview # Database schema, tables, relationships (SQL projects only)

🤝 贡献欢迎任何形式的贡献！通过 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 应用的浪潮。从个人移动应用开发者，到企业里的专业人士，在产品设计与研发方面积累了丰富经验。目前在 Kuaishou 任职，专注通用前端系统的研发与 AI 探索。

GitHub：sopaco

常见问题

Litho（deepwiki-rs）是什么？

Litho 是 AI 驱动的文档生成引擎，用 Rust 构建。它自动分析你的源代码，按 C4 模型格式生成全面、专业的架构文档。

Litho 支持哪些编程语言？

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

C4 模型是什么？

C4 模型是一套软件架构文档方法，包含四个层级：
- 上下文图（系统上下文）

- Container diagram (system containers)
- Component diagram (container components)
- Code diagram (component implementation)

How do I install Litho?
bash
cargo install deepwiki-rs

Or build from source:
bash
git clone https://github.com/sopaco/deepwiki-rs
cargo build --release

Can Litho integrate with CI/CD?

Yes, Litho can integrate with CI/CD pipelines to automatically generate documentation on every commit.

Why use Litho instead of manual documentation?

- Automatically keeps documentation in sync with codebase
- Saves hundreds of hours on manual maintenance
- Professional C4 model structure
- Consistent formatting and styling
- Easy to navigate and understand

Where can I get help?

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