sopaco/deepwiki-rs

Turn code into clarity. Generate accurate technical docs and AI-ready context in minutes—perfectly structured for human teams and intelligent agents.

Litho (deepwiki‑rs) – Rustで書かれたAI駆動型ドキュメント生成ツール

何ができるか – Lithoはソースコードリポジトリ全体をスキャンし、構造、コメント、依存関係を抽出した後、LLMを使ってそれらの情報をもとにC4モデル（コンテキスト、コンテナ、コンポーネント、コード図）の完全なアーキテクチャドキュメントに変換します。出力はコードと同期された読みやすいWikiです。

なぜ重要か – 技術ドキュメントを最新の状態に保つことは、開発者にとって長年の課題です。Lithoはパイプライン全体を自動化するため、チームはMarkdownの作成に費やす時間を減らし、より多くの時間をコーディングに集中できます。Rustバイナリとして実行されるため、高速かつCI/CDパイプラインに簡単に組み込むことができます。

主な機能（READMEに記載）

4段階のパイプライン – 前処理（コード発見・解析）、調査（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駆動のQ&Aも可能。
- Mermaid Fixer: マークダウン内の破損したMermaid図をスキャンし、AI補助で修復するユーティリティ。

動作方法（パイプライン概要）

前処理 – コードスキャナがファイルを発見し、構文を解析、コメントを抽出、依存関係グラフを構築。
調査 – 専用のAIエージェント（システムコンテキスト調査者、ドメインモジュール検出者、ワークフロー調査者など）がReAct推論ループを実行し、アーキテクチャの意図を推論し、中間レポートを生成。
ドキュメント生成 – エディタがC4モデル図、概要ページ、モジュールレベルのドキュメント、相互参照を階層的なMarkdownツリーに統合。
検証・強化 – Mermaid構文を検証・修正、完全性チェックを実行し、最終的な品質レポートを出力。

一般的なワークフロー

# クレートをインストール
cargo install deepwiki-rs

# リポジトリ上でLithoを実行（例）
litho generate --repo /path/to/project --output docs/

このコマンドにより、MarkdownファイルとMermaid図のディレクトリが生成され、直接配信可能またはLitho Bookで開いてより良いUIを体験できます。

誰が使うべきか

自動化された最新のアーキテクチャドキュメントを求める開発チーム。
メンテナンス負荷が低いWikiを求めるオープンソースメンテナ。
コンプライアンスのために監査可能なドキュメントが必要な企業。

関連プロジェクト – READMEではLithoは新しいプロジェクトTerrainに置き換えられました。TerrainはAIエージェント向けの動的なコードベースマップを追加しつつ、Lithoは高速なC4ドキュメント生成ツールとして引き続き利用可能です。

上記のすべての詳細はリポジトリのREADMEから直接引用；追加の機能は推測していません。