Ummon

🚀 Ummon

Ummon is a powerful code analysis tool designed to assist developers in understanding, managing, and optimizing their codebases. It parses source code in multiple programming languages, constructs a Knowledge Graph, and provides a series of Command-Line Interface (CLI) tools to aid development work.

🚀 Quick Start

Ummon is a potent code analysis tool crafted to empower developers in comprehending, managing, and optimizing their code repositories. It achieves this by parsing source code across various programming languages, constructing a Knowledge Graph, and offering a suite of Command-Line Interface (CLI) tools to streamline development processes.

⚠️ Important Note

This project is currently in its early stages. Please use it with caution.

✨ Features

Overview

Ummon offers a variety of core features, including:

• Code Analysis: Supports syntax parsing and semantic analysis of multiple programming languages such as Rust, Python, JavaScript, and Java.
• Knowledge Graph Construction: Stores entities (e.g., classes, functions, variables) and their relationships in the code as a graph structure for subsequent querying and analysis.
• Incremental Update Mechanism: Detects code changes and re-indexes only the affected parts, enhancing efficiency.
• LLM Integration: Integrates with Large Language Models (LLMs) to provide semantic understanding and intelligent recommendation capabilities.

Code Parsing

Ummon supports the parsing and analysis of the following programming languages:

• Rust: Supports syntax structures such as classes/structs, traits, implementations, functions, and modules.
• Python: Supports classes, functions, decorators, and import statements.
• JavaScript: Supports classes, regular functions, arrow functions, and import statements.
• Java: Supports classes, interfaces, methods, constructors, and field declarations.

Knowledge Graph Update

Ummon provides two ways to update the knowledge graph:

Incremental Update (Default Mode)

When the --full flag is not used, Ummon performs an incremental update:

• Records the timestamp of the last indexing operation.
• Detects files modified since the last indexing.
• Deletes entities and relationships related to the modified files.
• Re-indexes only the modified files, keeping the rest intact.

Full Reconstruction

When the --full flag is used, Ummon performs a full reconstruction:

• Clears all entities and relationships in the database.
• Re-indexes the entire codebase from scratch.
• Suitable for cases where the codebase has undergone significant changes or the graph is in an inconsistent state.

📦 Installation

Installation Guide

Please refer to the Quick Start Guide for installation and configuration.

Environment Variable Configuration

Ummon uses environment variables to manage sensitive information:

• OPENROUTER_API_KEY: The API key for accessing the LLM service (required for query and domain extraction functions).

💻 Usage Examples

CLI Tools

The following are the main commands provided by Ummon and their usage:

Indexing Commands

# Default incremental index of the current directory
cargo run -- index .

# Fully reconstruct the knowledge graph
cargo run -- index . --full

# Query the knowledge graph
cargo run -- query "显示所有函数"

Query Commands

# Basic query example
ummon query "show funcs"

# Structured query example
ummon query "select functions where file_path like 'src/auth/%'"

# Limit the number of results
ummon query "select functions" --limit 10

# Disable LLM processing
ummon query "select functions" --no-llm

Intelligent Recommendations

# Get code improvement suggestions
ummon suggest .

# Get field renaming suggestions
ummon suggest --rename-field User username

# Get function implementation suggestions
ummon suggest --implement-function calculate_discount

Advanced Features

Language Support

Ummon currently supports the parsing and analysis of the following programming languages:

• Rust
• Python
• JavaScript/TypeScript
• Java

Analysis Capabilities

Ummon can identify and store the following code elements:

• Classes and Interfaces: Including inheritance and implementation relationships.
• Functions and Methods: Including call and dependency relationships.
• Variables and Constants: Including scope and type information.
• Modules and Packages: Including import and export relationships.

LLM Integration

Ummon supports semantic understanding and intelligent recommendation capabilities through Large Language Models (LLMs), specifically including:

• Code snippet explanation
• Type inference assistance
• Refactoring suggestion generation
• Code smell detection

📚 Documentation

Please refer to the Developer Documentation to learn how to contribute code to Ummon or perform custom development.

📄 License

The Ummon open-source project is licensed under the MIT License. Please refer to the LICENSE file for specific terms.