diff --git a/docs/downloads.md b/docs/downloads.md index 83983f90..8ce51fed 100644 --- a/docs/downloads.md +++ b/docs/downloads.md @@ -11,8 +11,15 @@ OpenJarvis runs entirely on your hardware. Choose the interface that fits your w ## Desktop App -The native desktop app bundles Ollama (the inference engine) and the OpenJarvis Python backend -into a single installer. Download, open, and start chatting — no terminal required. +The desktop app is a native window for the OpenJarvis chat UI. All inference and backend +processing happens on your local machine — the app connects to the backend you start locally. + +!!! info "Backend required" + Start the backend before opening the desktop app. The quickstart script handles everything: + ```bash + git clone https://github.com/HazyResearch/OpenJarvis.git && cd OpenJarvis + ./scripts/quickstart.sh + ``` ### Download @@ -29,13 +36,14 @@ into a single installer. Download, open, and start chatting — no terminal requ ### What's included -The desktop app ships with: +The desktop app provides: -- **Ollama** sidecar — inference engine runs automatically in the background -- **OpenJarvis backend** — Python API server managed by the app -- **Full chat UI** — same interface as the browser app +- **Full chat UI** — same interface as the browser app, in a native window - **Energy monitoring** — real-time power consumption tracking -- **Telemetry dashboard** — token throughput, latency, and cost comparison +- **Telemetry dashboard** — token throughput, latency, and cost comparison vs. cloud models +- **System tray** — quick access without keeping a terminal open + +The backend (Ollama, Python API server, inference) runs separately on your machine. ### Build from source diff --git a/docs/index.md b/docs/index.md index 43296c5e..f80d3972 100644 --- a/docs/index.md +++ b/docs/index.md @@ -34,13 +34,25 @@ Everything runs on your hardware. Cloud APIs are optional. === "Desktop App" - Download the native desktop app — it bundles Ollama and the Python backend - so everything works out of the box. + The desktop app is a native window for the OpenJarvis UI. + The backend (Ollama + inference) runs on your machine — start it first, then open the app. + + **Step 1.** Start the backend: + + ```bash + git clone https://github.com/HazyResearch/OpenJarvis.git + cd OpenJarvis + ./scripts/quickstart.sh + ``` + + **Step 2.** Download and open the desktop app: [Download for macOS (Apple Silicon)](https://github.com/HazyResearch/OpenJarvis/releases/latest/download/OpenJarvis_aarch64.dmg){ .md-button .md-button--primary } Also available for [macOS (Intel)](https://github.com/HazyResearch/OpenJarvis/releases/latest/download/OpenJarvis_x64.dmg), [Windows](https://github.com/HazyResearch/OpenJarvis/releases/latest/download/OpenJarvis_x64-setup.exe), [Linux (DEB)](https://github.com/HazyResearch/OpenJarvis/releases/latest/download/OpenJarvis_amd64.deb), and [Linux (RPM)](https://github.com/HazyResearch/OpenJarvis/releases/latest/download/OpenJarvis_amd64.rpm). See the [Downloads](downloads.md) page for details. + The app connects to `http://localhost:8000` automatically. + === "Python SDK" ```python