🦙 LlamaBase

Privacy-first LLM integration with SQL visualization, local knowledge base, and comprehensive privacy monitoring

🚀 Quick Start

Install with npx (Recommended)

npx llamabase init
cd .llamabase
llamabase start

Install globally

npm install -g llamabase
llamabase init
cd .llamabase
llamabase start

Docker Hub

docker run -d -p 3000:3000 llamabase/llamabase

🎯 What is LlamaBase?

LlamaBase is a comprehensive, privacy-first platform that combines:

• 🔒 Privacy-First LLM Integration - Local processing with optional external API fallback
• 🗄️ SQL Database Visualization - Miro-like interface for database exploration
• 🧠 Local Knowledge Base - Private document storage and semantic search
• 📊 Real-time Privacy Monitoring - Complete transparency into data flows
• 🤖 AI-Powered Query Generation - Natural language to SQL conversion
• 🛡️ Compliance Checking - GDPR, CCPA, HIPAA compliance monitoring

✨ Key Features

🔒 Privacy First

• Local Processing - All data stays on your system by default
• Encrypted Connections - Secure database and API connections
• Privacy Monitoring - Real-time visibility into data flows
• Compliance Checking - Automatic GDPR, CCPA, HIPAA compliance
• Sensitive Data Detection - Automatic PII identification and protection

🗄️ SQL Visualization

• Miro-like Interface - Interactive, drag-and-drop database visualization
• Schema Diagrams - Visual representation of database structure
• Relationship Mapping - See connections between tables and data
• Network Graphs - Interactive network visualization
• Multi-Database Support - MySQL, PostgreSQL, SQLite

🤖 LLM Integration

• Natural Language to SQL - Convert plain English to SQL queries
• Local LLM Support - Use Ollama for completely private processing
• External API Fallback - OpenRouter integration when needed
• Query Explanation - Understand what your queries do
• Privacy-Aware Generation - AI considers privacy implications

📊 Knowledge Management

• Local Knowledge Base - Store and search documents privately
• Vector Database - Semantic search with Qdrant
• Document Processing - Automatic indexing and categorization
• Context Injection - Use knowledge in LLM conversations
• Privacy Controls - Complete control over data retention

🚀 Getting Started

1. Initialize LlamaBase

npx llamabase init

This creates a .llamabase directory with all necessary configuration files.

2. Configure Settings

llamabase config

Set your privacy mode, API keys, and other preferences.

3. Start Services

cd .llamabase
llamabase start

4. Access Your Dashboard

Open http://localhost:3000 in your browser to access:

• Main Dashboard - Overview of all services
• Privacy Dashboard - Real-time privacy monitoring
• SQL Visualizer - Database visualization and querying
• Knowledge Base - Document management and search

📊 Available Services

| Service | Port | Description | |---------|------|-------------| | Main Dashboard | 3000 | Unified interface for all features | | SQL Visualizer | 3001 | Database visualization and querying | | n8n Workflows | 5678 | Workflow automation and API management | | Knowledge Processor | 8000 | Document processing and search | | Query Engine | 8003 | SQL query processing and optimization | | Data Flow Monitor | 8001 | Real-time privacy monitoring | | Privacy Audit | 8002 | Compliance checking and reporting |

🔧 CLI Commands

llamabase init          # Initialize LlamaBase
llamabase start         # Start all services
llamabase stop          # Stop all services
llamabase status        # Check service status
llamabase logs          # View service logs
llamabase config        # Configure settings
llamabase update        # Update to latest version
llamabase info          # Show help and information

🔒 Privacy Modes

Strict Mode (Default)

• ✅ All processing local
• ✅ No external API calls
• ✅ Maximum data sanitization
• ✅ No interaction logging
• ❌ Limited functionality

Moderate Mode

• ✅ Local knowledge preferred
• ✅ Limited external APIs
• ✅ Data sanitization
• ✅ Interaction logging
• ⚠️ Some external calls

Open Mode

• ✅ Full functionality
• ✅ External APIs allowed
• ⚠️ Limited sanitization
• ⚠️ Full logging
• ❌ Less privacy

🗄️ Database Support

MySQL

• Full schema discovery
• Relationship mapping
• Query optimization
• Performance analysis

PostgreSQL

• Advanced schema features
• View and function support
• Index analysis
• Performance monitoring

SQLite

• Local file databases
• Embedded database support
• Lightweight visualization
• Portable data analysis

🤖 LLM Integration

Natural Language to SQL

// Ask in plain English
"Show me all users who registered in the last 30 days"

// Get generated SQL
SELECT * FROM users 
WHERE registration_date >= DATE_SUB(NOW(), INTERVAL 30 DAY)
ORDER BY registration_date DESC;

Local LLM Support

# Pull a model for local processing
docker-compose exec ollama ollama pull llama3.1:8b

External API Fallback

# Set your OpenRouter API key
llamabase config

📊 Visualization Types

Schema Diagrams

• Interactive table exploration
• Visual relationship mapping
• Column and constraint details
• Index visualization

Network Graphs

• Node-based table layout
• Interactive navigation
• Filtering and search
• Custom layouts

Data Charts

• Bar, line, and pie charts
• Time series visualization
• Correlation analysis
• Statistical summaries

Table Views

• Sortable and filterable
• Pagination support
• Export capabilities
• Real-time updates

🔧 Configuration

Environment Variables

# Privacy Settings
PRIVACY_MODE=strict
LOCAL_KNOWLEDGE_ENABLED=true
LOCAL_LLM_ENABLED=true

# API Keys
OPENROUTER_API_KEY=your_key_here

# Database Connections
MYSQL_HOST=localhost
MYSQL_PORT=3306
POSTGRES_HOST=localhost
POSTGRES_PORT=5432

Docker Compose

version: '3.8'
services:
  llamabase:
    image: llamabase:latest
    ports:
      - "3000:3000"
    environment:
      - PRIVACY_MODE=strict
    volumes:
      - llamabase_data:/app/data

🚀 Deployment Options

Local Development

npx llamabase init
llamabase start

Docker Compose

docker-compose up -d

Kubernetes

apiVersion: apps/v1
kind: Deployment
metadata:
  name: llamabase
spec:
  replicas: 1
  selector:
    matchLabels:
      app: llamabase
  template:
    metadata:
      labels:
        app: llamabase
    spec:
      containers:
      - name: llamabase
        image: llamabase:latest
        ports:
        - containerPort: 3000

Cloud Platforms

• AWS ECS - Container service deployment
• Google Cloud Run - Serverless container deployment
• Azure Container Instances - Container deployment
• DigitalOcean App Platform - Managed app deployment

🔒 Security Features

Data Protection

• Encrypted data transmission
• Secure API key management
• Local data storage
• Access control and authentication

Privacy Monitoring

• Real-time data flow tracking
• Sensitive data detection
• Compliance violation alerts
• Audit logging and reporting

Network Security

• HTTPS/TLS encryption
• CORS protection
• Rate limiting
• Input validation and sanitization

📚 Documentation

Getting Started

• Installation Guide
• Quick Start Tutorial
• Configuration Guide

Features

• SQL Visualization
• LLM Integration
• Privacy Monitoring
• Knowledge Base

API Reference

• REST API
• WebSocket API
• CLI Reference

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

git clone https://github.com/llamabase/llamabase.git
cd llamabase
npm install
npm run dev

Running Tests

npm test

Building

npm run build

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

Community

• GitHub Discussions
• Discord Server
• Stack Overflow

Professional Support

• Enterprise Support
• Consulting Services
• Training Programs

🎯 Roadmap

Upcoming Features

• [ ] Multi-user collaboration
• [ ] Advanced analytics dashboard
• [ ] Mobile app support
• [ ] Plugin system
• [ ] Enterprise SSO integration
• [ ] Advanced ML models
• [ ] Real-time collaboration
• [ ] Advanced security features

Version History

• v1.0.0 - Initial release with core features
• v1.1.0 - Enhanced privacy monitoring
• v1.2.0 - Advanced SQL visualization
• v1.3.0 - Local LLM integration
• v1.4.0 - Knowledge base features

🌟 Star History

🔒 Your Privacy, Your Control - LlamaBase gives you complete control over your data while providing powerful AI and visualization capabilities.

Made with ❤️ by the LlamaBase team