Welcome to Vaani!#
Hey there! 👋 I’m Aman Kumar Pandey, and this is Vaani - my personal AI voice assistant project.
Vaani (वाणी) means “voice” in Hindi. I built this because I wanted a voice assistant that:
Actually respects your privacy (runs mostly on your computer)
Works offline when needed
Supports multiple languages (I speak Hindi and English daily!)
Is proprietary software (currently not open-source)
Actually smart conversations (thanks to Google’s Gemini AI)
Think of it as your personal assistant that you fully control and understand.
Quick Start#
Want to try it out? Here’s the fastest way:
# Clone the project
git clone https://github.com/paman7647/vaani.git
cd vaani
# Set up (I've made this easy!)
chmod +x setup.sh
./setup.sh
# Run it!
python3 main.py
Then just say “Hey Vaani” and start talking! Pretty simple, right?
Where to Go Next#
Never used Vaani? Start with Getting Started - I’ll walk you through everything
Ready to install? Check out Detailed Installation Guide for step-by-step setup
Curious how it works? Read Architecture - I explain the tech in simple terms
Want to customize? See customization for all the tweaks you can make
Documentation Guide#
Getting Started
How It Works
- Architecture
- Voice and Audio System
- How Vaani Thinks
- Memory and Conversation Context
- Overview
- Memory Architecture
- Context Usage
- Entity Recognition and Tracking
- Conversation Flow
- Memory Limits
- Context Reset
- Context in Multi-Language
- Conversation State
- Technical Implementation
- Advanced Features
- Debugging Memory Issues
- Limitations
- Best Practices
- Configuration
- Performance Impact
- Next Steps
Make It Yours
For Developers
- Project Structure
- Repository Layout
- Entry Point
- Main Package (Vaani/)
- Configuration (config/)
- Core (core/)
- Voice (voice/)
- Intelligence (intelligence/)
- Integrations (integrations/)
- Utilities (utils/)
- Models Directory (models/)
- Documentation (docs/)
- Tests (tests/)
- Configuration Files
- Module Import Paths
- Architecture Diagrams
- Contributing
- Coding Style Guide
- Contributing Guide
Deployment & Performance