Friday-Subconscious / README.md
Paritosh Upadhyay
Fix: Delivering Neural ID Card to Cloud
1e32ce9
---
title: Friday Subconscious
emoji: 🧠
colorFrom: blue
colorTo: indigo
sdk: docker
pinned: false
---
# Project Jarvis
> Personal AI Assistant β€” 100% Local, Zero Cloud Dependencies
Jarvis is a voice-first personal AI assistant that runs entirely on your Mac. No data leaves your machine. No API keys required for core functionality.
## 🧠 What Powers Jarvis (All Local)
| Component | Technology | Purpose |
|---|---|---|
| **LLM Brain** | Ollama (llama3:8b) | Intent classification, reasoning, responses |
| **Speech-to-Text** | OpenAI Whisper (local) | Transcribes your voice commands |
| **Text-to-Speech** | Kokoro TTS + macOS native | Speaks responses back to you |
| **Wake Word** | openWakeWord | "Hey Jarvis" detection |
| **Memory** | ChromaDB + SQLite | Persistent memory and data storage |
| **Backend** | Python FastAPI | Service orchestration on localhost:7777 |
## πŸš€ Quick Start
### 1. Run Setup (one-time)
```bash
bash scripts/setup.sh
```
This installs all dependencies, downloads models, and configures everything.
### 2. Start Jarvis
```bash
bash scripts/start.sh
```
### 3. Use Jarvis
- **Web Dashboard**: Open `http://localhost:7777` in your browser
- **CLI Mode**: `cd backend && source venv/bin/activate && python cli.py`
- **Voice Mode**: `cd backend && source venv/bin/activate && python cli.py --voice`
- **API Docs**: `http://localhost:7777/docs`
### 4. Stop Jarvis
```bash
bash scripts/stop.sh
```
## πŸ“ Project Structure
```
Jarvis/
β”œβ”€β”€ backend/ # Python FastAPI server
β”‚ β”œβ”€β”€ app/
β”‚ β”‚ β”œβ”€β”€ api/ # REST API endpoints
β”‚ β”‚ β”œβ”€β”€ core/ # Brain, intent routing, context management
β”‚ β”‚ β”œβ”€β”€ services/ # STT, TTS, LLM, wake word, audio
β”‚ β”‚ └── models/ # Pydantic schemas
β”‚ β”œβ”€β”€ main.py # Server entry point
β”‚ β”œβ”€β”€ config.py # Configuration
β”‚ └── cli.py # Terminal interface
β”œβ”€β”€ static/ # Web dashboard
β”œβ”€β”€ app/ # macOS Swift menu bar app (Phase 2)
β”œβ”€β”€ models/ # Downloaded AI models
β”œβ”€β”€ data/ # Runtime data (SQLite, ChromaDB)
└── scripts/ # Setup, start, stop scripts
```
## πŸŽ™οΈ Voice Commands (Phase 0)
| Say This | Jarvis Does |
|---|---|
| "Hey Jarvis, what time is it?" | Tells you the current time |
| "Good morning" | Greets you with daily context |
| "What can you do?" | Lists available capabilities |
| "Draft an email to the team" | Drafts content for you |
| "Tell me a joke" | Engages in conversation |
## πŸ›£οΈ Roadmap
- **Phase 0** βœ… Core voice loop, LLM brain, web dashboard
- **Phase 1** πŸ”œ Expense tracking, SQLite database, ChromaDB memory
- **Phase 2** πŸ”œ Contact intelligence, Google Sheets integration
- **Phase 3** πŸ”œ OttoPilot CRM integration
- **Phase 4** πŸ”œ WhatsApp, Gmail, Calendar
- **Phase 5** πŸ”œ Call recording & memory
- **Phase 6** πŸ”œ Analytics & reporting
- **Phase 7** πŸ”œ macOS system intelligence
- **Phase 8** πŸ”œ Polish & hardening
- **Phase 9** πŸ”œ Mobile app (React Native)
## βš™οΈ Configuration
Edit `backend/.env` to customize:
- `OLLAMA_MODEL` β€” Change the LLM model (default: llama3:8b)
- `WHISPER_MODEL` β€” STT model size (tiny/base/small/medium/large)
- `TTS_ENGINE` β€” kokoro (neural) or macos (system voice)
- `OPENAI_API_KEY` β€” Optional GPT-4 fallback
---
*Built with ❀️ by Antigravity β€” Confidential*