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）的團隊。