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 login --all |
Batch authenticate WhatsApp, Telegram, Gmail, and Calendar |
jarvis bot --activate |
Activate the global Telegram Remote Control bot |
jarvis bot --status |
Check the live background status of your remote bot |
jarvis logout --all |
Revoke all connected service tokens instantly |
jarvis memory --clear |
Purge short-term AI contextual memory (keeps active sessions) |
jarvis reset --hard |
Factory reset: Wipes all property graphs, vector databases, and API sessions |
Dual-Brain Engine
JARVIS intelligently routes queries between two distinct processing engines based on complexity.
FastBrain
Fast LLM- ✦ Stateless, sub-second latency
- ✦ System controls (volume, brightness)
- ✦ YouTube playback & simple search
AgenticBrain
Multi-Provider- ✦ Stateful, deep reasoning engine
- ✦ File CRUD & code editing
- ✦ Python REPL & terminal automation
Memory System
A multi-tiered memory architecture ensures context persistence and deep relational awareness across sessions.
Rolling History (Short-Term)
15-day JSONL rolling history that provides immediate chronological context to the AgenticBrain, auto-archiving older data.
Bidirectional Property Graph (Long-Term)
Built on NetworkX. Extracts entities into a relational graph with temporal decay and inverse edges. Uses local all-MiniLM-L6-v2 embeddings for zero-latency semantic edge routing.
Hybrid Workspace RAG
Merges BM25 keyword search with Vector semantic search via Reciprocal Rank Fusion (RRF), automatically applying recency boosts to newly modified local documents.
Tool Ecosystem
Built-in capabilities available to the AgenticBrain.
Environment Variables
Configure API keys and settings in your .env file. The system is fully OpenAI‑compatible – use any provider that supports the OpenAI API format.
| Variable | Description | Status |
|---|---|---|
FAST_BRAIN_API_KEY |
API key for FastBrain (any OpenAI‑compatible provider) | Required |
FAST_BRAIN_MODEL |
Model name for FastBrain | Required |
FAST_BRAIN_ENDPOINT |
OpenAI‑compatible endpoint (e.g., Groq, OpenRouter, Local) | Required |
ROUTER_API_KEY |
API key for semantic router | Required |
ROUTER_MODEL |
Router model | Required |
ROUTER_ENDPOINT |
Router endpoint | Required |
LTM_EXTRACTION_API_KEY |
API key for lifelong memory extraction | Required |
LTM_EXTRACTION_MODEL |
Model for LTM extraction | Required |
LTM_EXTRACTION_ENDPOINT |
Endpoint for LTM extraction | Required |
IMAGE_GEN_API_KEY |
API key for image generation (OpenAI‑compatible) | Optional |
IMAGE_GEN_MODEL |
Image model (default: dall-e-3) | Optional |
IMAGE_GEN_ENDPOINT |
Image generation endpoint | Optional |
PROACTIVE_API_KEY |
API key for proactive scout | Required |
PROACTIVE_MODEL |
Model for proactive scout | Required |
PROACTIVE_ENDPOINT |
Endpoint for proactive scout | Required |
TTS_API_KEY |
API key for TTS (optional – falls back to Edge TTS) | Optional |
TTS_MODEL |
TTS model | Optional |
TTS_ENDPOINT |
TTS endpoint | Optional |
GROQ_API_KEY |
Backward-compatible alias for FAST_BRAIN_API_KEY |
Alias |
GEMINI_API_KEY |
Gemini API key (optional, used only if configured) | Optional |
REGOLO_API_KEY |
Regolo API key (optional) | Optional |
OPENROUTER_API_KEY |
OpenRouter API key (optional) | Optional |
TAVILY_API_KEY |
Real-time Web Search API key | Required |
DEEPGRAM_API_KEY |
Deepgram speech-to-text API key | Required |
ADB_PHONE_IP |
Tailscale IP of Android device | Optional |
TELEGRAM_API_ID & HASH |
Telegram App credentials for Desktop Client | Optional |
CUSTOM_BASE_URL |
For Ollama/LM Studio local inference | Optional |
Providers
JARVIS supports a flexible provider abstraction layer. You can use any OpenAI‑compatible endpoint, including:
Cloud Providers
Regolo, Gemini, Groq, OpenRouter, Together AI, OpenAI, Mistral, and more.
Local & Custom
Ollama, LM Studio, vLLM, or any custom server that implements the OpenAI API.
The system automatically falls back to secondary providers if the primary fails, ensuring zero downtime.
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. |
| FastBrain API Key Missing | Add FAST_BRAIN_API_KEY, FAST_BRAIN_MODEL, and FAST_BRAIN_ENDPOINT to your .env file. |