User manual¶
Welcome to the Jarvis user manual: a progressive guide to install, configure and use your personal AI assistant.
Living document
This manual is a living document: it is updated with every release as new features land. The Development phases page lists what is already available and what is coming.
Manual structure¶
-
Everything you need to bring up your first Jarvis node: hardware/software requirements, Docker, first boot.
-
Environment variables, OAuth, device pairing, LLM model choice, secrets vault.
-
How to talk to Jarvis, how to move between devices, how to use health, finance, news, RAG features.
-
Most common errors, logs to read, diagnostic commands, how to restore the instance.
-
Quick answers to the most frequent questions about privacy, costs, supported devices.
What you should know before starting¶
- 🐳 Docker is the easiest way to run Jarvis. Throughout this manual we assume Docker is installed.
- 🔐 Jarvis is self-hosted: your data stays on your hardware. You are the administrator.
- 🌍 Runs on Linux, macOS and Windows (via WSL2 for Windows).
- 🧪 It is in MVP phase: some described features are on the roadmap. See Phases.
Typical use cases¶
- Solo developer wanting a cross-IDE coding assistant → see Developer
- Health-tech user with Oura/Whoop wanting longitudinal insights → see Health
- Self-managed investor wanting a financial dashboard and briefings → see Finance
- Maker / 3D printing enthusiast with a connected printer → see Maker
- Knowledge worker with lots of Obsidian/Notion notes → see RAG
Ready? Start from Installation →