JARVIS Documentation
JARVIS is a desktop-native AI Operating System and Autonomous Agent that bridges low-latency conversational AI with complex, multi-step engineering execution.
Prerequisites
Ensure your environment meets these requirements before installing.
Python 3.10+
Required for async event loops and core agent modules.
Windows 10/11
Optimized for native desktop window controls.
Node.js 18+
Required for the Baileys WhatsApp Web socket bridge.
Git
For repository cloning and terminal tool execution.
Quick Install
Run the following commands in PowerShell to set up JARVIS locally.
jarvis to start.
CLI Commands
Manage sessions, memory, and services directly from your terminal.
| Command | Description |
|---|---|
jarvis login --whatsapp |
Start WhatsApp QR login |
jarvis login --telegram |
Start Telegram login (Phone + OTP) |
jarvis login --mail |
Start Gmail OAuth login |
jarvis login --calendar |
Start Google Calendar OAuth |
jarvis logout --all |
Logout from all connected services |
jarvis memory --clear |
Clear AI contextual memory |
jarvis reset --hard |
Factory reset (wipes memory and sessions) |
Dual-Brain Engine
JARVIS intelligently routes queries between two distinct processing engines based on complexity.
FastBrain Groq LPU
- ✦ Stateless, sub-second latency
- ✦ System controls (volume, brightness)
- ✦ YouTube playback & simple search
AgenticBrain Regolo / Gemini
- ✦ Stateful, deep reasoning engine
- ✦ File CRUD & code editing
- ✦ Python REPL & terminal automation
Memory System
A multi-tiered memory architecture ensures context persistence across sessions.
Rolling History (Short-Term)
15-day JSONL history that provides immediate context to the AgenticBrain.
Episodic Graph (Long-Term)
ChromaDB backend mapping semantic facts using Gemini embeddings, summarized daily.
Workspace RAG
Automatic indexing of local documents with smart chunking for instant retrieval.
Tool Ecosystem
Built-in capabilities available to the AgenticBrain.
Environment Variables
Configure API keys and settings in your .env file.
| Variable | Description | Status |
|---|---|---|
GROQ_API_KEY |
FastBrain and summarization endpoint | Required |
GEMINI_API_KEY |
Embeddings, Vision, and Reasoning | Required |
REGOLO_API_KEY |
Primary Agentic provider | Required |
DEEPGRAM_API_KEY |
Live Speech-to-Text | Required |
ADB_PHONE_IP |
Tailscale IP of Android device | Optional |
CUSTOM_BASE_URL |
For Ollama/LM Studio local inference | Optional |
Providers
JARVIS supports multi-LLM failover to ensure zero downtime.
Primary Routing
Regolo MoE, Gemini, and Groq handle primary compute load.
Fallback & Local
OpenRouter or Custom endpoints (Ollama/vLLM) activate on rate limits.
Mobile Control
Execute Android commands directly via ADB over Tailscale.
Proactive Agents & HITL
Background services act as scouts. They monitor incoming data but adhere strictly to the Human-in-the-Loop (HITL) protocol.
Example Flow
- Listener detects an email update regarding a meeting shift.
- JARVIS halts execution and prompts:
"I received an email from Ram that the meeting has been shifted to 5 PM. Should I update the calendar?" - User explicitly confirms via voice or text.
- JARVIS executes the calendar API update.
Troubleshooting
| Issue | Resolution |
|---|---|
| ModuleNotFoundError | Ensure .venv is activated before running pip install -r requirements.txt. |
| WhatsApp Fails | Verify Node.js 18+ is installed and npm install was run in the BaileysServer directory. |
| Command Not Recognized | Run python SetupRegistry.py from the project root and restart your terminal. |