Metadata-Version: 2.5
Name: locus-assistant
Version: 1.0.3
Summary: Locus — modular AI assistant backend with composable intelligence primitives
Project-URL: Homepage, https://github.com/aryanjsx/Locus
Project-URL: Documentation, https://aryanjsx.github.io/Locus/
Project-URL: Repository, https://github.com/aryanjsx/Locus
Project-URL: Issues, https://github.com/aryanjsx/Locus/issues
Author: Locus Contributors
License: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: <3.14,>=3.10
Requires-Dist: click>=8
Requires-Dist: croniter>=2.0
Requires-Dist: datasets>=4.5.0
Requires-Dist: ddgs>=9.11.4
Requires-Dist: httpx>=0.27
Requires-Dist: nvidia-ml-py>=12.560.30
Requires-Dist: openai>=1.30
Requires-Dist: posthog>=3.0
Requires-Dist: psutil>=5.9
Requires-Dist: python-telegram-bot>=22.8
Requires-Dist: rich>=13
Requires-Dist: tomli>=2.0; python_version < '3.11'
Requires-Dist: tomlkit>=0.12
Requires-Dist: websockets>=15.0.1
Provides-Extra: afm
Requires-Dist: apple-fm-sdk>=0.2.1; (sys_platform == 'darwin') and extra == 'afm'
Provides-Extra: browser
Requires-Dist: playwright>=1.40; extra == 'browser'
Provides-Extra: channel-discord
Requires-Dist: discord-py>=2.3; extra == 'channel-discord'
Provides-Extra: channel-gmail
Requires-Dist: google-api-python-client>=2.0; extra == 'channel-gmail'
Requires-Dist: google-auth-httplib2>=0.2; extra == 'channel-gmail'
Requires-Dist: google-auth-oauthlib>=1.0; extra == 'channel-gmail'
Provides-Extra: channel-line
Requires-Dist: line-bot-sdk>=3.0; extra == 'channel-line'
Provides-Extra: channel-mastodon
Requires-Dist: mastodon-py>=1.8; extra == 'channel-mastodon'
Provides-Extra: channel-messenger
Requires-Dist: pymessenger>=0.0.7; extra == 'channel-messenger'
Provides-Extra: channel-nostr
Requires-Dist: pynostr>=0.6; extra == 'channel-nostr'
Provides-Extra: channel-reddit
Requires-Dist: praw>=7.0; extra == 'channel-reddit'
Provides-Extra: channel-rocketchat
Requires-Dist: rocketchat-api>=1.30; extra == 'channel-rocketchat'
Provides-Extra: channel-slack
Requires-Dist: slack-sdk>=3.27; extra == 'channel-slack'
Provides-Extra: channel-telegram
Requires-Dist: python-telegram-bot>=21.0; extra == 'channel-telegram'
Provides-Extra: channel-twilio
Requires-Dist: twilio>=9.0; extra == 'channel-twilio'
Provides-Extra: channel-twitch
Requires-Dist: twitchio>=2.6; extra == 'channel-twitch'
Provides-Extra: channel-twitter
Requires-Dist: httpx>=0.27; extra == 'channel-twitter'
Provides-Extra: channel-viber
Requires-Dist: viberbot>=1.0; extra == 'channel-viber'
Provides-Extra: channel-xmpp
Requires-Dist: slixmpp>=1.8; extra == 'channel-xmpp'
Provides-Extra: channel-zulip
Requires-Dist: zulip>=0.9; extra == 'channel-zulip'
Provides-Extra: dashboard
Requires-Dist: textual>=0.80; extra == 'dashboard'
Provides-Extra: desktop
Requires-Dist: av<19,>=11; extra == 'desktop'
Requires-Dist: fastapi>=0.110; extra == 'desktop'
Requires-Dist: faster-whisper>=1.0; extra == 'desktop'
Requires-Dist: numpy>=1.24; extra == 'desktop'
Requires-Dist: onnxruntime<1.24; (python_version < '3.11') and extra == 'desktop'
Requires-Dist: onnxruntime<1.24; (sys_platform == 'darwin' and platform_machine == 'x86_64') and extra == 'desktop'
Requires-Dist: pydantic>=2.0; extra == 'desktop'
Requires-Dist: python-multipart>=0.0.9; extra == 'desktop'
Requires-Dist: sounddevice>=0.5; extra == 'desktop'
Requires-Dist: soundfile>=0.12; extra == 'desktop'
Requires-Dist: uvicorn>=0.30; extra == 'desktop'
Provides-Extra: dev
Requires-Dist: maturin>=1.12.6; extra == 'dev'
Requires-Dist: pre-commit>=3.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
Requires-Dist: pytest-cov>=5; extra == 'dev'
Requires-Dist: pytest-xdist>=3; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: respx>=0.22; extra == 'dev'
Requires-Dist: ruff>=0.4; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-gen-files>=0.5; extra == 'docs'
Requires-Dist: mkdocs-literate-nav>=0.6; extra == 'docs'
Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
Requires-Dist: mkdocs>=1.6; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.25; extra == 'docs'
Provides-Extra: energy-all
Requires-Dist: amdsmi>=6.1; extra == 'energy-all'
Requires-Dist: pynvml>=12.0; extra == 'energy-all'
Requires-Dist: zeus-apple-silicon>=1.1.0; (sys_platform == 'darwin') and extra == 'energy-all'
Provides-Extra: energy-amd
Requires-Dist: amdsmi>=6.1; extra == 'energy-amd'
Provides-Extra: energy-apple
Requires-Dist: zeus-apple-silicon>=1.1.0; (sys_platform == 'darwin') and extra == 'energy-apple'
Provides-Extra: eval-sheets
Requires-Dist: google-auth>=2.0; extra == 'eval-sheets'
Requires-Dist: gspread>=6.0; extra == 'eval-sheets'
Provides-Extra: eval-wandb
Requires-Dist: wandb>=0.17; extra == 'eval-wandb'
Provides-Extra: framework-comparison
Requires-Dist: polars>=1.0; extra == 'framework-comparison'
Provides-Extra: gpu-metrics
Requires-Dist: pynvml>=12.0; extra == 'gpu-metrics'
Provides-Extra: inference-cloud
Requires-Dist: anthropic>=0.30; extra == 'inference-cloud'
Requires-Dist: openai>=1.30; extra == 'inference-cloud'
Provides-Extra: inference-gemma
Requires-Dist: pygemma>=0.1.3; extra == 'inference-gemma'
Provides-Extra: inference-google
Requires-Dist: google-genai>=1.0; extra == 'inference-google'
Provides-Extra: inference-litellm
Requires-Dist: litellm==1.104.2; extra == 'inference-litellm'
Provides-Extra: inference-mlx
Requires-Dist: mlx-lm>=0.31.1; (sys_platform == 'darwin') and extra == 'inference-mlx'
Provides-Extra: inference-vllm
Requires-Dist: vllm>=0.30.0; extra == 'inference-vllm'
Provides-Extra: learning-dspy
Requires-Dist: dspy>=2.6; extra == 'learning-dspy'
Provides-Extra: learning-gepa
Requires-Dist: gepa>=0.1; extra == 'learning-gepa'
Provides-Extra: media
Requires-Dist: openai>=1.30; extra == 'media'
Provides-Extra: memory-bm25
Requires-Dist: rank-bm25>=0.2.2; extra == 'memory-bm25'
Provides-Extra: memory-colbert
Requires-Dist: colbert-ai>=0.2; extra == 'memory-colbert'
Requires-Dist: torch>=2.0; extra == 'memory-colbert'
Provides-Extra: memory-faiss
Requires-Dist: faiss-cpu>=1.7; extra == 'memory-faiss'
Requires-Dist: numpy>=1.24; extra == 'memory-faiss'
Requires-Dist: sentence-transformers>=2.2; extra == 'memory-faiss'
Provides-Extra: memory-pdf
Requires-Dist: pdfplumber>=0.10; extra == 'memory-pdf'
Provides-Extra: mining-pearl-cpu
Provides-Extra: mining-pearl-vllm
Requires-Dist: docker>=7.0; extra == 'mining-pearl-vllm'
Requires-Dist: httpx>=0.27; extra == 'mining-pearl-vllm'
Provides-Extra: openhands
Requires-Dist: openhands-sdk>=1.0; (python_version >= '3.12') and extra == 'openhands'
Provides-Extra: orchestrator-training
Requires-Dist: torch>=2.0; extra == 'orchestrator-training'
Requires-Dist: transformers>=4.40; extra == 'orchestrator-training'
Provides-Extra: pdf
Requires-Dist: pdfplumber>=0.10; extra == 'pdf'
Provides-Extra: sandbox-docker
Requires-Dist: docker>=7.0; extra == 'sandbox-docker'
Provides-Extra: sandbox-wasm
Requires-Dist: wasmtime>=25; extra == 'sandbox-wasm'
Provides-Extra: scheduler
Requires-Dist: croniter>=2.0; extra == 'scheduler'
Provides-Extra: security-signing
Requires-Dist: cryptography>=43; extra == 'security-signing'
Provides-Extra: server
Requires-Dist: fastapi>=0.110; extra == 'server'
Requires-Dist: pydantic>=2.0; extra == 'server'
Requires-Dist: python-multipart>=0.0.9; extra == 'server'
Requires-Dist: uvicorn>=0.30; extra == 'server'
Provides-Extra: speech
Requires-Dist: av<19,>=11; extra == 'speech'
Requires-Dist: faster-whisper>=1.0; extra == 'speech'
Requires-Dist: numpy>=1.24; extra == 'speech'
Requires-Dist: onnxruntime<1.24; (python_version < '3.11') and extra == 'speech'
Requires-Dist: onnxruntime<1.24; (sys_platform == 'darwin' and platform_machine == 'x86_64') and extra == 'speech'
Requires-Dist: sounddevice>=0.5; extra == 'speech'
Requires-Dist: soundfile>=0.12; extra == 'speech'
Provides-Extra: speech-deepgram
Requires-Dist: deepgram-sdk>=3.0; extra == 'speech-deepgram'
Provides-Extra: tools-search
Requires-Dist: ddgs>=9.11.4; extra == 'tools-search'
Requires-Dist: tavily-python>=0.3; extra == 'tools-search'
Provides-Extra: voice
Requires-Dist: kokoro>=0.9; extra == 'voice'
Requires-Dist: numpy>=1.24; extra == 'voice'
Requires-Dist: sounddevice>=0.5; extra == 'voice'
Requires-Dist: soundfile>=0.12; extra == 'voice'
Description-Content-Type: text/markdown


<div align="center">

# Locus

### A private, offline-first assistant for your PC

**Type or speak a command. Locus does it, on your machine, without sending anything to the cloud.**

![Status](https://img.shields.io/badge/status-alpha-orange)
![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-0078D6)
![License](https://img.shields.io/github/license/aryanjsx/Locus)
[![XERJ Corpus Hub contributor](https://hub.xerj.org/contributors/aryanjsx/badge.svg)](https://hub.xerj.org/contributors/aryanjsx)


[Website](https://aryanjsx.github.io/Locus/) · [Why Locus](#why-locus) · [MVP scope](#mvp-scope) · [Safety](#safety) · [Requirements](#system-requirements) · [Tech stack](#tech-stack) · [Roadmap](#roadmap) · [Docs](#documentation)

</div>

## Why Locus?

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, [Intelligence Per Watt](https://www.intelligence-per-watt.ai/) research from Stanford's Hazy 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.

Locus is that stack. It is a 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. Locus aims to be both a research platform and a production foundation for local AI, in the spirit of PyTorch.

## Installation

Pick your platform and run one command. Each installer handles [uv](https://docs.astral.sh/uv/), the Python venv, Ollama, and a starter model — about 3 minutes on broadband.

| Platform | One-liner |
|---|---|
| **macOS · Linux · WSL2** | `curl -fsSL https://aryanjsx.github.io/Locus/install.sh \| bash` |
| **Native Windows** | `irm https://aryanjsx.github.io/Locus/install.ps1 \| iex` |
| **Desktop GUI** | Download `.exe` / `.dmg` / `.deb` / `.rpm` / `.AppImage` from the [latest release](https://github.com/aryanjsx/Locus/releases) |

Then `locus` to start. The Rust extension and larger models continue downloading in the background; `locus doctor` shows status.

Platform-specific notes (WSL2 setup, native-Windows scheduled-task service, desktop prerequisites, manual / contributor install): see the [installation docs](https://aryanjsx.github.io/Locus/getting-started/install/).

## Quick Start

```bash
locus                          # start chatting (default: chat-simple)
locus gui                      # start the graphical browser interface
locus init --preset <name> --force  # replace config with a starter preset
```

`locus gui` starts the local API server and frontend, then opens the graphical
chat interface in your default browser. It requires Node.js 22+ and is
available from a source checkout; packaged desktop installers are available
from the [latest release](https://github.com/aryanjsx/Locus/releases).

> Prefix `locus ...` with `uv run`, or `source .venv/bin/activate` first.

#### Run from a Windows source checkout

Install [uv](https://docs.astral.sh/uv/), [Node.js 22+](https://nodejs.org/),
and [Ollama](https://ollama.com/), then run these commands from the repository
root in PowerShell:

```powershell
uv sync --extra desktop
Push-Location frontend
npm install
Pop-Location
ollama pull qwen3:0.6b
uv run locus gui
```

If Ollama is not already running, start it in another terminal with
`ollama serve`. The GUI should open in your browser.

To run the test suite from the repository root:

```powershell
uv sync --extra dev
uv run pytest tests/ -v
```

| Preset | What it does |
|---|---|
| `morning-digest-mac` / `morning-digest-linux` / `morning-digest-minimal` | Spoken daily briefing from email, calendar, health, news |
| `deep-research` | Multi-hop research across indexed docs with citations |
| `code-assistant` | Agent with code execution, file I/O, and shell access |
| `scheduled-monitor` | Stateful agent on a schedule with memory |
| `chat-simple` | Lightweight conversation, no tools |

Example:

```bash
locus init --preset morning-digest-mac --force
locus connect gdrive          # one OAuth covers Gmail / Calendar / Tasks
locus digest --fresh          # generate and play your first briefing
```

Per-preset deep dives: [morning digest](https://aryanjsx.github.io/Locus/user-guide/morning-digest/) · [deep research](https://aryanjsx.github.io/Locus/user-guide/deep-research/) · [code assistant](https://aryanjsx.github.io/Locus/user-guide/code-assistant/) · [scheduled monitor](https://aryanjsx.github.io/Locus/user-guide/scheduled-monitor/) · [chat simple](https://aryanjsx.github.io/Locus/user-guide/chat-simple/) · or the full [quickstart guide](https://aryanjsx.github.io/Locus/getting-started/quickstart/).

### Skills

Skills teach agents how to better use tools and improve their reasoning. Every skill is a tool — agents discover them from a catalog and invoke them on demand.

```bash
# Install skills from public sources
locus skill install hermes:arxiv
locus skill sync hermes --category research

# Use skills with any agent
locus ask "Use the code-explainer skill to explain this Python code: for i in range(5): print(i*2)"

# Optimize skills from your trace history
locus optimize skills --policy dspy

# Benchmark the impact
locus bench skills --max-samples 5 --seeds 42
```

Import from [Hermes Agent](https://github.com/NousResearch/hermes-agent) (~150 skills), [OpenClaw](https://github.com/openclaw/skills) (~13,700 community skills), or any GitHub repo. Skills follow the [agentskills.io](https://agentskills.io/specification) open standard.

See the [Skills User Guide](https://aryanjsx.github.io/Locus/user-guide/skills/) and [Skills Tutorial](https://aryanjsx.github.io/Locus/tutorials/skills-workflow/) for details.

### Built-in Agents

Locus ships with eight built-in agents across three execution modes (on-demand, scheduled, continuous):

| Agent | Type | What it does |
|-------|------|-------------|
| `morning_digest` | Scheduled | Daily briefing from email, calendar, health, news — with TTS audio |
| `deep_research` | On-demand | Multi-hop research with citations across web and local docs |
| `monitor_operative` | Continuous | Long-horizon monitoring with memory, compression, and retrieval |
| `orchestrator` | On-demand | Multi-turn reasoning with automatic tool selection |
| `native_react` | On-demand | ReAct (Thought-Action-Observation) loop agent |
| `operative` | Continuous | Persistent autonomous agent with state management |
| `native_openhands` | On-demand | CodeAct — generates and executes Python code |
| `simple` | On-demand | Single-turn chat, no tools |

See the [User Guide](https://aryanjsx.github.io/Locus/user-guide/morning-digest/) and [Tutorials](https://aryanjsx.github.io/Locus/tutorials/) for detailed setup instructions.

Full documentation — including Docker deployment, cloud engines, development setup, and tutorials — at **[aryanjsx.github.io/Locus](https://aryanjsx.github.io/Locus/)**.

## Community

- **GitHub:** [github.com/aryanjsx/Locus](https://github.com/aryanjsx/Locus)
- **Discussions:** [github.com/aryanjsx/Locus/discussions](https://github.com/aryanjsx/Locus/discussions)
- **Docs:** [aryanjsx.github.io/Locus](https://aryanjsx.github.io/Locus/)

## 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/aryanjsx/Locus.git
cd Locus
uv sync --extra dev
uv run pre-commit install
uv run pytest tests/ -v
```

Browse the [Roadmap](https://aryanjsx.github.io/Locus/development/roadmap/) for areas where help is needed. Comment **"take"** on any issue to get auto-assigned.

## Acknowledgments

Locus is a modified version of [OpenJarvis](https://github.com/open-jarvis/OpenJarvis), an open-source framework for local-first personal AI developed at [Hazy Research](https://hazyresearch.stanford.edu/) and the [Scaling Intelligence Lab](https://scalingintelligence.stanford.edu/) at [Stanford SAIL](https://ai.stanford.edu/) as part of [Intelligence Per Watt](https://www.intelligence-per-watt.ai/). OpenJarvis is licensed under Apache 2.0; see [NOTICE](NOTICE) for details. Locus is an independent project and is not affiliated with or endorsed by Stanford or the OpenJarvis authors.

If you use the underlying research, please cite the OpenJarvis paper:

```bibtex
@misc{saadfalcon2026openjarvispersonalaipersonal,
      title={OpenJarvis: Personal AI, On Personal Devices}, 
      author={Jon Saad-Falcon and Avanika Narayan and Robby Manihani and Tanvir Bhathal and Herumb Shandilya and Hakki Orhun Akengin and Gabriel Bo and Andrew Park and Matthew Hart and Caia Costello and Chuan Li and Christopher Ré and Azalia Mirhoseini},
      year={2026},
      eprint={2605.17172},
      archivePrefix={arXiv},
      primaryClass={cs.LG},
      url={https://arxiv.org/abs/2605.17172}, 
}
```

## License

[Apache 2.0](LICENSE)
