Repository navigation
Home
Kshitij Joshi edited this page May 26, 2026
·
2 revisions
Natural language interface for PostgreSQL databases using AI. Ask questions in plain English and get instant answers!
- Home - Overview and introduction
- Quick Start - Get up and running in 5 minutes
- Installation - Detailed installation instructions
- Configuration - Configure your setup
- User Guide - How to use the application
- Query Examples - Example queries and use cases
- Best Practices - Tips for getting the best results
- Architecture - System architecture and design
- API Reference - Backend API documentation
- Database Schema - Database structure
- Embeddings Guide - Setting up semantic search
- Development Setup - Setup for contributors
- Testing - How to run tests
- Deployment - Deploy to production
- Troubleshooting - Common issues and solutions
- FAQ - Frequently asked questions
- Performance Tuning - Optimize your setup
- 🗣️ Natural Language Queries - Ask in plain English
- 🤖 Local AI - Powered by Ollama (100% free)
- 🔒 Secure - Read-only, safe queries
- 📊 Beautiful UI - Modern React interface
- 🚀 Fast - Optimized PostgreSQL
- 🔍 Semantic Search - Vector-based search with pgvector
- Business Intelligence - Quick insights from your data
- Data Exploration - Discover patterns and trends
- Reporting - Generate reports in natural language
- Training - Learn SQL by seeing generated queries
- Accessibility - Database access for non-technical users
See CHANGELOG for version history.
See CONTRIBUTING for guidelines.