R1

2026-09-11 14:55:34 -04:00
parent 660294d0aa
commit 25b2c4be2e
33 changed files with 1293 additions and 34 deletions
@@ -0,0 +1,57 @@
+# Operations guide
+
+## Prerequisites
+
+Ubuntu GNOME 24.04 or newer, Node.js 22.17+, PipeWire/WirePlumber, GNOME
+desktop portals, GTK4/libadwaita, AT-SPI2, and a QVAC-visible GPU are required
+for the full runtime. See [hardware compatibility](hardware-compatibility.md).
+
+## Development start
+
+```bash
+npm ci
+npm test
+npm run gpu-doctor
+npm run cu-doctor
+npm run voice-doctor
+node daemon/index.js
+```
+
+Use `npm run qvac:serve:diagnostic` only when a separate local client needs the
+OpenAI-compatible endpoint. Keep its host at `127.0.0.1`.
+
+## User service
+
+```bash
+systemctl --user daemon-reload
+systemctl --user enable --now jarvisd.service
+systemctl --user status jarvisd.service
+journalctl --user -u jarvisd.service -f
+```
+
+The packaged service uses `~/.local/share/jarvis-qvac` and the generated config
+at `~/.config/jarvis/qvac.config.json`. The repository development unit uses
+the checkout path; use the packaged unit when testing installation behavior.
+
+## Extension development
+
+```bash
+gnome-extensions enable [email protected]
+dbus-run-session -- gnome-shell --nested --wayland
+```
+
+Keep inference and long-running work in `jarvisd`. Reloading the Shell is only
+needed for extension changes; daemon changes can use `node --watch`.
+
+## State and storage
+
+| Location | Contents | Default retention |
+| --- | --- | --- |
+| `~/.local/share/jarvis/memory` | harness memory and RAG data | user-managed |
+| `~/.local/share/jarvis/voices` | local voice references | user-managed |
+| `~/.local/share/jarvis/audit` | CU action metadata and hashes | user-managed |
+| `~/.cache/jarvis` | models, jobs, temporary CU state | disposable |
+| `~/Jarvis` | generated media and transcripts | user-managed |
+
+Use the uninstall script with `--yes`; add `--purge-data` only to remove the
+listed Jarvis-owned data locations.