A multi AI agent CLI tool using Microsoft Autogen Framework
Project description
VaahAI
VaahAI is a multi-agent AI CLI tool built with Microsoft's Autogen Framework, designed to enhance code quality and development workflows through AI-powered code review, auditing, generation, and scaffolding capabilities.
๐ Features
- Multi-Agent Architecture: Specialized AI agents collaborate to perform complex tasks
- Code Review: Comprehensive code review focusing on quality, style, and best practices
- Code Audit: Security vulnerability detection, compliance checking, and architectural assessment
- Code Generation: AI-powered code generation from natural language descriptions
- Multiple LLM Support: OpenAI, Claude, Junie, and local models via Ollama
- Intelligent Model Selection: Filter and recommend models based on capabilities (text, code, vision, etc.)
- Flexible Configuration: Layered configuration system with global defaults and project-specific settings
- Git Integration: Commit applied changes, generate meaningful commit messages, and prepare pull requests
๐ Getting Started
Prerequisites
- Python 3.9+
- Poetry (Python package manager)
- Git
- Docker (optional, for code execution)
Installation
# Install from PyPI
pip install vaahai
# Or clone the repository
git clone https://github.com/webreinvent/vaahai.git
cd vaahai
# Install dependencies with Poetry
poetry install
# Activate the Poetry virtual environment
poetry shell
Quick Start
# Initialize configuration
vaahai config init
# Show current configuration
vaahai config show
# List available models
vaahai model list
# Run a simple test to verify installation
vaahai helloworld run
Development Setup
# Install development dependencies
poetry install --with dev
# Install pre-commit hooks
pre-commit install
# Run tests
poetry run pytest
# Run tests with coverage
poetry run pytest --cov=vaahai
# Format code
poetry run black vaahai
poetry run isort vaahai
# Lint code
poetry run flake8 vaahai
poetry run mypy vaahai
# Run all pre-commit hooks manually
pre-commit run --all-files
For more details on development tools, see Development Tools Documentation.
Configuration
# Run the configuration wizard
poetry run vaahai config init
# Or manually edit the configuration file
nano ~/.vaahai/config.toml
๐ ๏ธ Usage
CLI Command Structure
VaahAI provides a modular CLI organized into logical command groups. The command structure follows this hierarchy:
vaahai [command_group] [command] [action] [options]
Where:
vaahaiis the main CLI applicationcommand_groupis one of the logical groups (core, project, dev)commandis a specific command within that groupactionis a subcommand or action for that commandoptionsare additional flags and parameters
Enhanced Help System
VaahAI features a Rich-formatted custom help system that provides visually appealing and well-organized help information:
- Styled headers and descriptions with visual separation
- Organized tables for commands, options, and environment variables
- Consistent formatting across all commands and subcommands
- Detailed descriptions and usage examples
- Color-coded elements for improved readability
To access the enhanced help for any command:
# Main CLI help
vaahai --help
# Command group help
vaahai [command_group] --help
# Specific command help
vaahai [command_group] [command] --help
# Command action help
vaahai [command_group] [command] [action] --help
Global Options
--version,-v: Display the current version of VaahAI and exit--verbose,-V: Enable verbose output with detailed logs and information--quiet,-q: Suppress non-essential output--config: Specify an alternative configuration file path--help,-h: Show help message and exit
Core Commands
vaahai config: Configuration managementvaahai config init: Set up initial configurationvaahai config show: Display current configuration
vaahai version: Display version information
Project Commands
vaahai review: Code review commandsvaahai review run: Run a code review on specified path
vaahai audit: Security and compliance audit commandsvaahai audit run: Run a security/compliance audit on specified path
Development Commands
vaahai dev helloworld: Test command to verify proper functioningvaahai dev helloworld run: Execute the hello world test
vaahai dev showcase: Demonstrate Rich formatting capabilitiesvaahai dev prompts: Demonstrate InquirerPy prompt capabilities
All commands support the --help flag for detailed usage information. For backward compatibility, direct command access (e.g., vaahai helloworld instead of vaahai dev helloworld) is also supported.
Interactive Prompts
VaahAI CLI uses InquirerPy to provide interactive command-line prompts with rich styling. The prompt utilities include:
- Text input with validation
- Password input with masking
- Confirmation prompts (yes/no)
- Selection from a list of options
- Multi-selection from a list of options
- Fuzzy search selection
- Number input with range validation
- Path selection with auto-completion
All prompts support non-interactive mode with default values or appropriate error handling.
Basic Commands
# Show help information
vaahai --help
# Show help for a specific command group
vaahai dev --help
# Show help for a specific command
vaahai dev helloworld --help
# Test installation and configuration
vaahai dev helloworld run
# Or using backward compatibility
vaahai helloworld run
# Review code in a file or directory
vaahai review run --path ./my_project --depth standard
# This follows the structure: vaahai [command_group] [command] [action] [options]
# Audit a project for security and compliance
vaahai audit run --path ./my_project --security --compliance owasp
# Show version information
vaahai version
# Apply suggested changes
vaahai apply --file review_suggestions.json
# Commit the changes
vaahai commit --message "Fix code quality issues in app.py"
Example Workflow
# Initialize configuration
vaahai config init
# Review a Python file
vaahai review run --path ./app.py --focus quality
# Apply suggested changes
vaahai apply --file review_suggestions.json
# Commit the changes
vaahai commit --message "Fix code quality issues in app.py"
Terminal Output
VaahAI CLI uses Rich for consistent, styled terminal output. Output behavior can be controlled with:
- Verbose mode: Set
--verboseflag orVAAHAI_VERBOSE=1environment variable - Quiet mode: Set
--quietflag orVAAHAI_QUIET=1environment variable
For more details on the Rich integration, see the Rich Integration Documentation.
๐งช Testing
VaahAI includes a comprehensive test suite organized into unit tests and integration tests:
vaahai/test/
โโโ unit/ # Tests for individual components
โ โโโ test_cli_utils.py # Tests for console output utilities
โ โโโ test_help_utils.py # Tests for help formatting utilities
โ โโโ test_version.py # Tests for version command
โโโ integration/ # Tests for component interactions
โโโ test_config_integration.py # Tests for config command
Run the test suite:
# Run all tests
poetry run pytest
# Run tests with coverage report
poetry run pytest --cov=vaahai
# Run specific test file
poetry run pytest vaahai/test/unit/test_cli_utils.py
# Run tests matching a pattern
poetry run pytest -k "config"
For more details on testing, see Testing Guide and Test Implementation.
๐๏ธ Project Structure
vaahai/
โโโ ai_docs/ # AI-specific documentation
โโโ ai_prompts/ # Prompt templates for AI agents
โโโ docs/ # User and developer documentation
โ โโโ cli/ # CLI-specific documentation
โโโ specs/ # Project specifications and requirements
โโโ vaahai/ # Main package
โ โโโ agents/ # Agent implementations
โ โโโ cli/ # CLI commands and handlers
โ โ โโโ commands/ # Command implementations
โ โ โ โโโ core/ # Core command group
โ โ โ โ โโโ config/ # Configuration commands
โ โ โ โ โโโ version/ # Version commands
โ โ โ โโโ project/ # Project command group
โ โ โ โ โโโ audit/ # Audit commands
โ โ โ โ โโโ review/ # Code review commands
โ โ โ โโโ dev/ # Development command group
โ โ โ โ โโโ helloworld/ # Hello world test command
โ โ โ โ โโโ showcase/ # Rich formatting showcase
โ โ โ โโโ helloworld/ # Legacy direct command (for backward compatibility)
โ โ โโโ main.py # CLI entry point
โ โ โโโ utils/ # CLI utilities
โ โ โโโ console.py # Rich formatting utilities
โ โ โโโ help.py # Custom help formatting
โ โโโ config/ # Configuration management
โ โโโ llm/ # LLM provider integrations
โ โโโ utils/ # Utility functions and helpers
โโโ tests/ # Test suite
โโโ cli/ # CLI tests
๐ Documentation
For more detailed documentation, please refer to:
- Project Plan
- Features Specification
- Technical Architecture
- User Guide
- API Reference
- CLI Documentation
๐ค Contributing
We welcome contributions from the community! Please see our Contributing Guidelines for more details on how to get involved.
๐ License
This project is licensed under the MIT License - see the LICENSE file for details.
๐ Acknowledgements
- Microsoft Autogen Framework
- Typer
- InquirerPy
- All our contributors and supporters
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vaahai-0.2.21.tar.gz.
File metadata
- Download URL: vaahai-0.2.21.tar.gz
- Upload date:
- Size: 52.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.13.3 Darwin/24.5.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a3786e73974613151dd070a335895addd9c07c0dff8a8664e1c937370944697b
|
|
| MD5 |
ce423e3de78e63eec542ff875427ef2e
|
|
| BLAKE2b-256 |
4bbcd3ab7f2810c53593049452ab99865773dd9375a3a323de478991f855616b
|
File details
Details for the file vaahai-0.2.21-py3-none-any.whl.
File metadata
- Download URL: vaahai-0.2.21-py3-none-any.whl
- Upload date:
- Size: 70.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.1.3 CPython/3.13.3 Darwin/24.5.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
453fef918ae2059f83fdedb6317792fd370c39d797f21cfbe9bb76bc6d6cd8d8
|
|
| MD5 |
e90729bf5d17f66c12537e28639f4b6d
|
|
| BLAKE2b-256 |
dc9c35fc99c98dcf8c56b130494c2fd9ac6f8f4ba120f796a9d458961421d3e5
|