Ummon

🚀 Ummon - 強大的代碼分析工具

Ummon 是一款功能強大的代碼分析工具，旨在助力開發者更好地理解、管理和優化代碼庫。它通過解析多種編程語言的源代碼，構建知識圖譜，並提供命令行接口工具，為開發工作提供有力支持。

🚀 快速開始

注意：本項目目前處於早期階段，請謹慎使用。若需更多幫助，可訪問 GitHub 倉庫 或查閱相關文檔。

✨ 主要特性

功能概述

Ummon 具備多種核心功能，具體如下：

• 代碼分析：支持對 Rust、Python、JavaScript 和 Java 等多種編程語言進行語法解析和語義分析。
• 知識圖譜構建：將代碼中的實體（如類、函數、變量等）及其關係以圖結構存儲，方便後續查詢與分析。
• 增量更新機制：能檢測代碼變化，僅對受影響部分重新索引，提升效率。
• LLM 集成：結合大語言模型（Large Language Model, LLM），提供語義理解和智能推薦功能。

代碼解析

Ummon 支持對以下編程語言進行解析和分析：

• Rust：支持類/結構體、特徵、實現、函數和模塊等語法結構。
• Python：支持類、函數、裝飾器和導入語句。
• JavaScript：支持類、普通函數、箭頭函數和導入語句。
• Java：支持類、接口、方法、構造函數和字段聲明。

知識圖譜更新

Ummon 提供兩種知識圖譜更新方式：

增量更新（默認模式）

不使用 --full 標誌時，Ummon 執行增量更新：

• 記錄上次索引操作的時間戳。
• 檢測自上次索引以來修改的文件。
• 刪除與已修改文件相關的實體和關係。
• 僅重新索引已修改的文件，保留其餘部分。

完全重建

使用 --full 標誌時，Ummon 執行完全重建：

• 清空數據庫中的所有實體和關係。
• 從頭開始重新索引整個代碼庫。
• 適用於代碼庫發生重大變化或圖譜處於不一致狀態的情況。

📦 安裝指南

安裝步驟

請參考 快速入門指南 進行安裝和配置。

環境變量配置

Ummon 使用環境變量管理敏感信息：

• OPENROUTER_API_KEY：用於訪問 LLM 服務的 API 密鑰（查詢和領域抽取功能需要）。

💻 使用示例

命令行工具

索引命令

# 默認增量索引當前目錄
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 文件。