From 9f033aaaf8b78c9e0b40af0863ececf4ddaaf94c Mon Sep 17 00:00:00 2001 From: milo Date: Wed, 26 Nov 2025 00:30:09 -0500 Subject: [PATCH] Add README.md --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f94eaed --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# 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 | ++------+ +---------+