JarvisAssistant/README.md
2025-11-26 00:30:09 -05:00

62 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Project: Jarvis Personal Homelab Assistant
## 1. Vision
Build a **personal “Jarvis” assistant** that runs its **brain on the server (LLM)** and uses **lightweight clients** on your machines (desktop, Unraid, etc.) to:
- Monitor system health (containers, disks, CPU/GPU, services).
- Surface relevant info when you log in (tasks, alerts, emails).
- Execute safe, high-level commands (open apps, organize files, run scripts).
- Eventually feel like a **real assistant**, not just a smart speaker.
---
## 2. Goals & Non-Goals
### 2.1 Goals
- ✅ Central “brain” that understands:
- System status (servers, containers, resources).
- Personal context (tasks, projects, important emails).
- ✅ Multiple clients (desktop, server, etc.) sending telemetry and executing actions.
- ✅ Natural language front-end:
- CLI chat at first (voice later).
- Greeting on Windows login with a status summary.
- ✅ Safe, auditable actions:
- File organizing in whitelisted directories.
- Opening apps / scripts.
- Reporting server issues proactively.
### 2.2 Non-Goals (for early versions)
- ❌ Full smart-home integration (lights, thermostats, etc.).
- ❌ Generic “AI for everything” (keep it focused on **your** workflow).
- ❌ Full voice assistant (wake word, STT/TTS) in v0.x. Nice-to-have later.
- ❌ Direct shell access for the LLM (no raw `cmd / bash` execution).
---
## 3. High-Level Architecture
```text
+-------------------------+
| LLM Brain |
| (Server on Unraid) |
+-----------+-------------+
^
| HTTP / JSON
v
+-----------+-------------+
| Controller / API |
| (FastAPI or similar) |
+-----------+-------------+
^
|
+--------+--------+
| |
v v
+------+ +---------+
|Client| |Client |
|Win10 | |Unraid |
|Desktop |Agent |
+------+ +---------+