🤖 AI Companion

A private, self-hosted AI assistant with persistent memory, voice interaction, and agentic capabilities — accessible as a PWA from any device, including instant launch via the iPhone Action Button.

---

🚀 Features

Category	Capabilities
🎙️ Voice Interface	Real-time Speech-to-Text via Faster Whisper (GPU-accelerated), natural TTS responses
🧠 Persistent Memory	Long-term memory with ChromaDB vector embeddings — your companion remembers everything
💬 Conversational AI	Powered by OpenRouter with support for multiple LLM backends (GPT-4o, Claude, Llama, etc.)
🔧 Agentic Tools	Code execution sandbox, web research, email integration, and extensible tool system
📱 PWA	Installable Progressive Web App with offline support and iPhone Action Button integration
🐳 Fully Dockerized	One-command deployment with GPU passthrough — zero host pollution

---

🛠️ Tech Stack

┌───────────────────────────────────────────────┐
│                  Frontend                     │
│  React / Vite  ->  PWA  ->  Web Audio API     │
├───────────────────────────────────────────────┤
│                  Backend                      │
│  FastAPI  ->  Faster Whisper  ->  ChromaDB    │
│  SQLite   ->  OpenRouter SDK  ->  TTS Engine  │
├───────────────────────────────────────────────┤
│               Infrastructure                  │
│  Docker Compose  ->  NVIDIA Container Toolkit │
└───────────────────────────────────────────────┘

---

📋 Prerequisites

Requirement	Version	Notes
Docker Desktop	24.0+	or Docker Engine on Linux
NVIDIA Container Toolkit	Latest	Required for GPU-accelerated STT
NVIDIA GPU	6 GB+ VRAM	For Whisper large-v3; smaller models need less
Git	2.0+	For cloning the repository

Note

GPU is required for local Whisper STT. If you don't have an NVIDIA GPU, you can switch STT_MODE to api in your .env to use a cloud-based STT provider instead.

---

⚡ Quick Start

# 1. Clone the repository
git clone https://github.com/your-username/AI_Companion.git
cd AI_Companion

# 2. Create your environment file
cp .env.example .env

# 3. Edit .env with your API keys
#    At minimum, set OPENROUTER_API_KEY
nano .env   # or use your preferred editor

# 4. Build and launch
docker compose up --build

# 5. Open the app
#    Frontend:  http://localhost:3000
#    Backend:   http://localhost:8000/docs  (Swagger UI)

Tip

Use docker compose up --build -d to run in detached mode. View logs with docker compose logs -f.

---

🔌 API Endpoints

The backend exposes a RESTful API at http://localhost:8000. Full interactive documentation is available at /docs (Swagger UI) and /redoc (ReDoc).

Method	Endpoint	Description
POST	/api/chat	Send a text message and receive an AI response
POST	/api/voice/transcribe	Upload audio for Speech-to-Text transcription
POST	/api/voice/synthesize	Convert text to speech audio
GET	/api/memory/search	Search long-term memory by semantic query
POST	/api/memory/add	Manually add an entry to long-term memory
GET	/api/conversations	List all conversation sessions
GET	/api/conversations/{id}	Retrieve a specific conversation history
DELETE	/api/conversations/{id}	Delete a conversation session
POST	/api/tools/execute	Execute code in the sandboxed environment
POST	/api/tools/research	Perform web research on a topic
GET	/api/health	Health check and system status

---

📲 PWA Installation

Desktop (Chrome / Edge)

1. Navigate to http://localhost:3000
2. Click the install icon in the address bar
3. Click Install

iOS (Safari)

1. Open Safari and navigate to https://your-host:3000
2. Tap Share → Add to Home Screen
3. (Optional) Set up the Action Button for instant voice access — see the iOS Action Button Setup Guide

Android (Chrome)

1. Navigate to https://your-host:3000
2. Tap the "Add to Home Screen" banner, or Menu → Install App

PWA & Security Hardening

• Auth Rate Limiting: The backend enforces sliding-window rate limiting on /api/auth/login (5 attempts/min) and /api/auth/refresh (20 attempts/min) returning HTTP 429 with Retry-After headers to protect against brute-force attacks and token replay.
• Offline Fallback Experience: Built-in responsive offline.html fallback with live connection health diagnostics and automatic reconnect polling when internet connectivity drops.
• Rich App Manifest: Enhanced PWA manifest with application shortcuts (Start Voice Chat, 3D Avatars), categories, and maskable icons for desktop and mobile install dialogs.

Testing & Verification

Run the test suites across backend and frontend inside the dev container:

# Backend pytest suite (auth, rate limiting, and security invariants)
cd backend && .venv/bin/python -m pytest

# Frontend test suite (API client, token refresh coalescing, and PWA manifest)
cd frontend && npm test

---

📁 Project Structure

AI_Companion/
├── backend/                  # FastAPI backend service
│   ├── Dockerfile
│   ├── requirements.txt
│   ├── main.py               # Application entry point
│   ├── api/                   # Route handlers
│   │   ├── chat.py
│   │   ├── voice.py
│   │   ├── memory.py
│   │   └── tools.py
│   ├── core/                  # Business logic
│   │   ├── llm.py             # OpenRouter LLM integration
│   │   ├── stt.py             # Faster Whisper STT engine
│   │   ├── tts.py             # Text-to-Speech engine
│   │   ├── memory.py          # ChromaDB vector memory
│   │   └── sandbox.py         # Code execution sandbox
│   └── models/                # Pydantic schemas
├── frontend/                  # React PWA frontend
│   ├── Dockerfile
│   ├── package.json
│   ├── vite.config.js
│   ├── public/
│   │   └── manifest.json      # PWA manifest
│   └── src/
│       ├── App.jsx
│       ├── components/        # UI components
│       └── services/          # API client modules
├── data/                      # Persistent data (git-ignored)
│   ├── companion.db           # SQLite database
│   └── chromadb/              # Vector embeddings
├── sandbox/                   # Code execution workspace (git-ignored)
├── docs/                      # Documentation
│   └── ios-action-button-setup.md
├── docker-compose.yml         # Container orchestration
├── .env                       # Environment variables (git-ignored)
├── .env.example               # Environment template (safe to commit)
├── .gitignore
├── LICENSE
└── README.md

---

🗺️ Roadmap

Phase 1 — Foundation (current)

• Docker infrastructure with GPU passthrough
• FastAPI backend with health checks
• Faster Whisper STT integration
• OpenRouter LLM chat pipeline
• SQLite conversation persistence
• React PWA frontend with voice recording

Phase 2 — Intelligence

• ChromaDB long-term vector memory
• Semantic memory search and recall
• Agentic tool system (code execution, web research)
• TTS voice response pipeline
• Conversation context management

Phase 3 — Polish & Expansion

• iPhone Action Button integration & auto-record
• Email sending capability
• Multi-modal input (images, documents)
• Custom personality and system prompts
• Scheduled tasks and reminders
• Plugin architecture for community tools

---

🤝 Contributing

Contributions are welcome! Please open an issue or submit a pull request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

---

📄 License

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

---

Built with ❤️ and a healthy distrust of cloud-only AI

## Authentication setup

Before exposing this instance, follow Authentication and trusted accounts. The development ports bind to localhost. Registration and demo login are disabled by default; create the first trusted account locally, then disable registration. All operational API requests require a Bearer token. The frontend handles token attachment, refresh, and sign-out.