mirror of
https://github.com/open-jarvis/OpenJarvis.git
synced 2026-07-28 14:07:55 +00:00
robbym-dev
79b7ae9701
Closes #158 — the README and installation docs assumed uv was already installed without explaining how to get it, creating a barrier for new users (especially on macOS). Adds a prerequisites table to both the README and docs/getting-started/installation.md with platform-specific install commands, and links to the existing macOS step-by-step guide.
127 lines
6.1 KiB
Markdown
127 lines
6.1 KiB
Markdown
<div align="center">
|
||
<img alt="OpenJarvis" src="assets/OpenJarvis_Horizontal_Logo.png" width="400">
|
||
|
||
<p><i>Personal AI, On Personal Devices.</i></p>
|
||
|
||
<p>
|
||
<a href="https://scalingintelligence.stanford.edu/blogs/openjarvis/"><img src="https://img.shields.io/badge/project-OpenJarvis-blue" alt="Project"></a>
|
||
<a href="https://open-jarvis.github.io/OpenJarvis/"><img src="https://img.shields.io/badge/docs-mkdocs-blue" alt="Docs"></a>
|
||
<img src="https://img.shields.io/badge/python-%3E%3D3.10-blue" alt="Python">
|
||
<img src="https://img.shields.io/badge/license-Apache%202.0-green" alt="License">
|
||
<a href="https://discord.gg/wfXEkpPX"><img src="https://img.shields.io/badge/discord-join-7289da?logo=discord&logoColor=white" alt="Discord"></a>
|
||
</p>
|
||
</div>
|
||
|
||
---
|
||
|
||
> **[Documentation](https://open-jarvis.github.io/OpenJarvis/)**
|
||
>
|
||
> **[Project Site](https://scalingintelligence.stanford.edu/blogs/openjarvis/)**
|
||
>
|
||
> **[Leaderboard](https://open-jarvis.github.io/OpenJarvis/leaderboard/)**
|
||
>
|
||
> **[Roadmap](https://open-jarvis.github.io/OpenJarvis/development/roadmap/)**
|
||
|
||
## Why OpenJarvis?
|
||
|
||
Personal AI agents are exploding in popularity, but nearly all of them still route intelligence through cloud APIs. Your "personal" AI continues to depend on someone else's server. At the same time, our [Intelligence Per Watt](https://www.intelligence-per-watt.ai/) research showed that local language models already handle 88.7% of single-turn chat and reasoning queries, with intelligence efficiency improving 5.3× from 2023 to 2025. The models and hardware are increasingly ready. What has been missing is the software stack to make local-first personal AI practical.
|
||
|
||
OpenJarvis is that stack. It is an opinionated framework for local-first personal AI, built around three core ideas: shared primitives for building on-device agents; evaluations that treat energy, FLOPs, latency, and dollar cost as first-class constraints alongside accuracy; and a learning loop that improves models using local trace data. The goal is simple: make it possible to build personal AI agents that run locally by default, calling the cloud only when truly necessary. OpenJarvis aims to be both a research platform and a production foundation for local AI, in the spirit of PyTorch.
|
||
|
||
## Installation
|
||
|
||
### Prerequisites
|
||
|
||
| Tool | Install |
|
||
|------|---------|
|
||
| **Python 3.10+** | [python.org](https://www.python.org/downloads/) |
|
||
| **uv** (Python package manager) | `curl -LsSf https://astral.sh/uv/install.sh \| sh` — or `brew install uv` on macOS |
|
||
| **Rust** | `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs \| sh` |
|
||
| **Git** | [git-scm.com](https://git-scm.com/) — or `brew install git` on macOS |
|
||
|
||
> **macOS users:** see the full [macOS Installation Guide](https://open-jarvis.github.io/OpenJarvis/getting-started/macos/) for a step-by-step walkthrough including Homebrew setup.
|
||
|
||
### Setup
|
||
|
||
```bash
|
||
git clone https://github.com/open-jarvis/OpenJarvis.git
|
||
cd OpenJarvis
|
||
uv sync # core framework
|
||
uv sync --extra server # + FastAPI server
|
||
|
||
# Build the Rust extension
|
||
uv run maturin develop -m rust/crates/openjarvis-python/Cargo.toml
|
||
```
|
||
|
||
> **Python 3.14+:** set `PYO3_USE_ABI3_FORWARD_COMPATIBILITY=1` before the `maturin` command.
|
||
|
||
You also need a local inference backend: [Ollama](https://ollama.com), [vLLM](https://github.com/vllm-project/vllm), [SGLang](https://github.com/sgl-project/sglang), or [llama.cpp](https://github.com/ggerganov/llama.cpp). Alternatively, use the `cloud` engine with [OpenAI](https://openai.com), [Anthropic](https://anthropic.com), [Google Gemini](https://ai.google.dev), [OpenRouter](https://openrouter.ai), or [MiniMax](https://www.minimax.io) by setting the corresponding API key environment variable.
|
||
|
||
## Quick Start
|
||
|
||
```bash
|
||
# 1. Install and detect hardware
|
||
git clone https://github.com/open-jarvis/OpenJarvis.git
|
||
cd OpenJarvis
|
||
uv sync
|
||
uv run jarvis init
|
||
|
||
# 2. Start Ollama and pull a model
|
||
curl -fsSL https://ollama.com/install.sh | sh
|
||
ollama serve &
|
||
ollama pull qwen3:8b
|
||
|
||
# 3. Ask a question
|
||
uv run jarvis ask "What is the capital of France?"
|
||
```
|
||
|
||
`jarvis init` auto-detects your hardware and recommends the best engine. Run `uv run jarvis doctor` at any time to diagnose issues.
|
||
|
||
Full documentation — including Docker deployment, cloud engines, development setup, and tutorials — at **[open-jarvis.github.io/OpenJarvis](https://open-jarvis.github.io/OpenJarvis/)**.
|
||
|
||
## Contributing
|
||
|
||
We welcome contributions! See the [Contributing Guide](CONTRIBUTING.md) for incentives, contribution types, and the PR process.
|
||
|
||
Quick start for contributors:
|
||
|
||
```bash
|
||
git clone https://github.com/open-jarvis/OpenJarvis.git
|
||
cd OpenJarvis
|
||
uv sync --extra dev
|
||
uv run pre-commit install
|
||
uv run pytest tests/ -v
|
||
```
|
||
|
||
Browse the [Roadmap](https://open-jarvis.github.io/OpenJarvis/development/roadmap/) for areas where help is needed. Comment **"take"** on any issue to get auto-assigned.
|
||
|
||
## About
|
||
|
||
OpenJarvis is part of [Intelligence Per Watt](https://www.intelligence-per-watt.ai/), a research initiative studying the efficiency of on-device AI systems. The project is developed at [Hazy Research](https://hazyresearch.stanford.edu/) and the [Scaling Intelligence Lab](https://scalingintelligence.stanford.edu/) at [Stanford SAIL](https://ai.stanford.edu/).
|
||
|
||
## Sponsors
|
||
|
||
<p>
|
||
<a href="https://www.laude.org/">Laude Institute</a> •
|
||
<a href="https://datascience.stanford.edu/marlowe">Stanford Marlowe</a> •
|
||
<a href="https://cloud.google.com/">Google Cloud Platform</a> •
|
||
<a href="https://lambda.ai/">Lambda Labs</a> •
|
||
<a href="https://ollama.com/">Ollama</a> •
|
||
<a href="https://research.ibm.com/">IBM Research</a> •
|
||
<a href="https://hai.stanford.edu/">Stanford HAI</a>
|
||
</p>
|
||
|
||
## Citation
|
||
```bibtex
|
||
@misc{saadfalcon2026openjarvis,
|
||
title={OpenJarvis: Personal AI, On Personal Devices},
|
||
author={Jon Saad-Falcon and Avanika Narayan and Herumb Shandilya and Hakki Orhun Akengin and Robby Manihani and Gabriel Bo and John Hennessy and Christopher R\'{e} and Azalia Mirhoseini},
|
||
year={2026},
|
||
howpublished={\url{https://scalingintelligence.stanford.edu/blogs/openjarvis/}},
|
||
}
|
||
```
|
||
|
||
## License
|
||
|
||
[Apache 2.0](LICENSE)
|