Ummon

🚀 Ummon

Ummonは強力なコード分析ツールで、開発者がコードライブラリを理解、管理、最適化するのを支援します。複数のプログラミング言語のソースコードを解析し、知識グラフ（Knowledge Graph）を構築し、一連のコマンドラインインターフェース（CLI）ツールを提供して開発作業を支援します。

🚀 クイックスタート

Ummonは、開発者がコードライブラリを理解、管理、最適化するのを支援するための強力なコード分析ツールです。複数のプログラミング言語のソースコードを解析し、知識グラフを構築します。

⚠️ 重要提示

本プロジェクトは現在初期段階です。ご利用には十分に注意してください。

✨ 主な機能

機能概要

Ummonは、以下のような様々な核心機能を提供しています。

• コード分析：Rust、Python、JavaScript、Javaなど、複数のプログラミング言語の構文解析と意味解析をサポートします。
• 知識グラフ構築：コード内のエンティティ（クラス、関数、変数など）とその関係をグラフ構造として保存し、後続のクエリと分析を容易にします。
• 増分更新メカニズム：コードの変更を検出し、影響を受ける部分のみを再インデックスすることで、効率を向上させます。
• LLM統合：大規模言語モデル（Large Language Model, LLM）と組み合わせることで、意味理解とインテリジェントな推薦機能を提供します。

コード解析

Ummonは、以下のプログラミング言語の解析と分析をサポートしています。

• Rust：クラス/構造体、トレイト、実装、関数、モジュールなどの構文構造をサポートします。
• Python：クラス、関数、デコレータ、インポート文をサポートします。
• JavaScript：クラス、通常の関数、アロー関数、インポート文をサポートします。
• Java：クラス、インターフェース、メソッド、コンストラクタ、フィールド宣言をサポートします。

知識グラフの更新

Ummonは、2種類の知識グラフ更新方法を提供しています。

増分更新（デフォルトモード）

--full フラグを使用しない場合、Ummonは増分更新を実行します。

• 前回のインデックス操作のタイムスタンプを記録します。
• 前回のインデックス以降に変更されたファイルを検出します。
• 変更されたファイルに関連するエンティティと関係を削除します。
• 変更されたファイルのみを再インデックスし、残りの部分は保持します。

完全再構築

--full フラグを使用すると、Ummonは完全再構築を実行します。

• データベース内のすべてのエンティティと関係を削除します。
• コードライブラリ全体を最初から再インデックスします。
• コードライブラリに大きな変更があった場合や、グラフが不一致な状態の場合に適しています。

📦 インストール

インストールガイド

インストールと設定については、クイックスタートガイド を参照してください。

環境変数の設定

Ummonは、環境変数を使用して機密情報を管理します。

• OPENROUTER_API_KEY：LLMサービスにアクセスするためのAPIキー（クエリと領域抽出機能に必要）。

💻 使用例

コマンドラインツール

以下は、Ummonが提供する主なコマンドとその使用方法です。

インデックスコマンド

# デフォルトで現在のディレクトリを増分インデックス
cargo run -- index .

# 知識グラフを完全に再構築
cargo run -- index . --full

# 知識グラフをクエリ
cargo run -- query "すべての関数を表示"

クエリコマンド

# 基本的なクエリの例
ummon query "show funcs"

# 構造化クエリの例
ummon query "select functions where file_path like 'src/auth/%'"

# 結果の数を制限
ummon query "select functions" --limit 10

# LLM処理を無効にする
ummon query "select functions" --no-llm

インテリジェントな推薦

# コードの改善提案を取得
ummon suggest .

# フィールドのリネーム提案を取得
ummon suggest --rename-field User username

# 関数の実装提案を取得
ummon suggest --implement-function calculate_discount

📚 ドキュメント

言語サポート

Ummonは、現在以下のプログラミング言語の解析と分析をサポートしています。

• Rust
• Python
• JavaScript/TypeScript
• Java

分析能力

Ummonは、以下のコード要素を識別して保存することができます。

• クラスとインターフェース：継承関係、実装関係など。
• 関数とメソッド：呼び出し関係、依存関係など。
• 変数と定数：スコープ、型情報など。
• モジュールとパッケージ：インポート関係、エクスポート関係など。

LLM統合

Ummonは、大規模言語モデル（LLM）を通じて意味理解とインテリジェントな推薦機能を提供します。具体的には以下の機能があります。

• コードスニペットの説明
• 型推論の支援
• リファクタリング提案の生成
• コードの悪臭検出

開発ガイド

Ummonにコードを貢献したり、カスタム開発を行う方法については、開発者ドキュメント を参照してください。

FAQ

よくある質問

1. どのプログラミング言語をサポートしていますか？
   • Rust、Python、JavaScript、Javaをサポートしています。
2. 大規模なコードライブラリはどのように処理しますか？
   • 増分更新メカニズムを使用し、十分なハードウェアリソースを確保することをお勧めします。
3. ヘルプを取得するにはどうすればいいですか？
   • GitHubリポジトリ にアクセスして問題を投稿するか、ドキュメントを参照してください。

📄 ライセンス

Ummonオープンソースプロジェクトは、MITライセンスに従っています。詳細な条項については、LICENSE ファイルを参照してください。

コードの貢献

Ummonにコードを貢献したり、カスタム開発を行う方法については、開発者ドキュメント を参照してください。

⚠️ 重要提示

本プロジェクトは現在初期段階です。ご利用には十分に注意してください。

もっとヘルプが必要な場合は、GitHubリポジトリ にアクセスするか、関連ドキュメントを参照してください。