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；未推斷任何額外功能。