Skip to main content

🚀 ClickHouse AI Agent - Intelligent database analysis and operations

Project description

🚀 Moja - ClickHouse AI Agent

A beautiful, intelligent CLI agent for ClickHouse database analysis and operations.

✨ Features

  • 🤖 AI-Powered: Intelligent natural language interface for ClickHouse operations
  • 📊 Data Analysis: Comprehensive table analysis with statistics and insights
  • 📈 Visualizations: Create beautiful charts and graphs from query results
  • 📥 Data Loading: Load CSV, JSON files into ClickHouse with auto-schema detection
  • 📤 Data Export: Export query results to various formats (CSV, JSON, Parquet, Excel)
  • 🔧 Database Management: Table optimization, system information, and more
  • 🎨 Beautiful CLI: Rich, colorful interface with progress bars and tables

🛠️ Installation

Quick Install (Recommended)

Install globally with pipx for the best experience:

pipx install moja-clickhouse-agent

Then run:

moja

This will start the interactive onboarding flow to configure your database and AI provider.

Manual Installation

# Clone the repository
git clone https://github.com/vish/moja.git
cd moja

# Install dependencies
pip install -r requirements.txt

# Set up your configuration
export OPENROUTER_API_KEY="your-api-key"
export CLICKHOUSE_HOST="localhost"
export CLICKHOUSE_PORT="8123"

🚀 Quick Start

Interactive Chat Mode

moja chat

Execute Single Query

moja query "SELECT * FROM my_table LIMIT 10"

Analyze Table

moja analyze my_table --deep

Load Data

moja load-data data.csv my_table

🔧 Configuration

Create a .env file or use environment variables:

# ClickHouse Configuration
CLICKHOUSE_HOST=localhost
CLICKHOUSE_PORT=8123
CLICKHOUSE_USERNAME=default
CLICKHOUSE_PASSWORD=
CLICKHOUSE_DATABASE=default

# OpenRouter Configuration
OPENROUTER_API_KEY=your-api-key-here
OPENROUTER_MODEL=openai/gpt-4o-mini

🤖 AI Capabilities

Moja understands natural language commands like:

  • "Show me all tables in the database"
  • "Analyze the user_events table and find patterns"
  • "Create a bar chart showing sales by month"
  • "Load the CSV file into a new table"
  • "Export the query results to Excel"

🏗️ Architecture

Built with modern Python tools:

  • Typer: Beautiful CLI interface
  • Rich: Colorful terminal output
  • ClickHouse Connect: Fast database connectivity
  • OpenRouter: AI model access
  • Plotly: Interactive visualizations
  • Pandas: Data manipulation

📖 Examples

Data Analysis

# Interactive session
python main.py chat

> "Analyze my sales_data table and show me the top products"
> "Create a line chart showing revenue trends over time"
> "Find any anomalies in the user behavior data"

Batch Operations

# Load multiple files
python main.py load-data sales_2023.csv sales_data
python main.py load-data users.json user_profiles

# Analyze and export
python main.py analyze sales_data --deep
python main.py query "SELECT * FROM sales_data WHERE revenue > 1000" --format csv --save results.csv

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📄 License

MIT License - see LICENSE file for details.


Built with ❤️ for the ClickHouse community

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

moja_clickhouse_agent-1.0.4.tar.gz (40.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

moja_clickhouse_agent-1.0.4-py3-none-any.whl (44.4 kB view details)

Uploaded Python 3

File details

Details for the file moja_clickhouse_agent-1.0.4.tar.gz.

File metadata

  • Download URL: moja_clickhouse_agent-1.0.4.tar.gz
  • Upload date:
  • Size: 40.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for moja_clickhouse_agent-1.0.4.tar.gz
Algorithm Hash digest
SHA256 561cb993542a3d78ab8b3301232ed978c9f5ec8d55966e996c97650465e9f15b
MD5 ed0c23dc1c88546c5bd7a0df6d5f318f
BLAKE2b-256 98689764790d63778259b738ef624976dfa8196fbe00c428ecd8ec107aa2c235

See more details on using hashes here.

File details

Details for the file moja_clickhouse_agent-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for moja_clickhouse_agent-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ba390b55a6e4350fdb9646e18c63bfa21c1b121b52a97ff37547a8af3c579415
MD5 465b8759b5228ee311d1ea0f45a975c1
BLAKE2b-256 58628950cbcee090d05dbe7da297fe3bdb861e1bb8f9967544c0fd6b56b178b7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page