Getting Started
Installation
Installation paths for Windows, macOS, and Linux. Windows is the hardware-tested desktop target.
Personal Jarvis is a full, downloadable desktop app — one product with three native faces. The installer pulls every feature in one step; you bring your own API keys on first run.
Requirements
- Python 3.11+
- Node 18+ (only for the
npxinstall path) - A microphone and speakers for the voice experience (optional — see headless)
- No GPU required. Local models are an installed-by-default upgrade, never a hard requirement.
One-liner (recommended)
The fastest path. It builds a Python virtual environment, installs everything, and launches the first-run wizard.
Windows (PowerShell):
irm https://raw.githubusercontent.com/PersonalJarvis/PersonalJarvis/main/install/install.ps1 | iex
macOS · Linux:
curl -fsSL https://raw.githubusercontent.com/PersonalJarvis/PersonalJarvis/main/install/install.sh | bash
Open source — inspect the installer before you run it. It only sets up a venv, installs dependencies, and runs the wizard for your keys.
Via npm
No git clone needed — pipx installs the CLI in isolation, then serves.
pipx install "git+https://github.com/PersonalJarvis/PersonalJarvis" && jarvis serve
Manual
Clone it, read every line, then run.
git clone https://github.com/PersonalJarvis/PersonalJarvis
cd PersonalJarvis
python -m venv .venv && source .venv/bin/activate # Windows: .\.venv\Scripts\Activate.ps1
pip install -e .[full]
jarvis serve
Install flags
| Flag | Effect |
|---|---|
--headless | API + WebSocket only, no desktop window or voice |
--with-voice-local | Pull the local STT/TTS/wake models on install |
--no-launch | Install only; do not start the app |
--no-wizard | Skip the first-run key wizard |
Headless / servers
No GPU and no audio hardware required. Run Jarvis headless on any Linux box and reach the full experience through the browser UI (over WebSocket) or a channel adapter — Telegram, Discord, SMS, or webhook. The base install boots cleanly on a bare python:3.11-slim container; desktop-only capabilities degrade to a logged no-op where the hardware is absent.