ahmedkhaleel2004/gitdiagram
Free, simple, fast interactive diagrams for any GitHub repository
何を解決するか
GitDiagramは複雑なGitHubリポジトリをインタラクティブなアーキテクチャ図に変換します。コードベースを手動でマッピングしたり、フォルダを一つずつ確認したりするのではなく、開発者はプロジェクト内のシステムレベルの構造と関係をすばやく可視化できます。
動作方法
このツールはGitHub API経由でリポジトリのデフォルトブランチ、ファイルツリー、READMEを取得します。その後、2段階のAIプロセスを実行します。まず、アーキテクチャの平易な英語による説明を生成し、次に、ノード、エッジ、パスを含む構造化されたグラフAST（抽象構文木）を生成します。このASTは実際のリポジトリファイルと検証され、その後ブラウザでレンダリングされるMermaid図にコンパイルされます。
対象ユーザー
すべてのファイルを手動で読まなくても、公開または非公開のGitHubリポジトリの高レベル設計をすばやく理解したい開発者やアーキテクト。
特徴
- アーキテクチャ中心：単なるフォルダ構造ではなく、システムレベルのグラフをマッピング。
- インタラクティブ：図内のコンポーネントはGitHub上の対応するファイルまたはディレクトリに直接リンク。
- プライベートリポジトリ対応：ブラウザ内でローカルにGitHubトークンを提供することで、プライベートコードベースを可視化可能。
- ストリーミング生成：グラフの計画が進行する間に、AIが生成した説明をリアルタイムで表示。
- エクスポートオプション：PNGとしてのダウンロードやMermaidソースコードのコピーをサポート。
関連
- プロジェクト
- プロジェクト
- プロジェクト
- プロジェクト