Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

NovaAI_Horizontal_Logo

Personal AI, On Personal Devices.

Python License


NOVA AI demo reel

Complete Setup & User Guide

Documentation

Roadmap

Prerequisites

NOVA AI is local-first: the only hard requirement is Python. Everything else is optional, depending on how you want to run models.

Requirement Version Required? Notes
Python 3.10 – 3.13 ✅ Required 3.14 is not supported (no numpy 2.2 wheels — see pyproject.toml)
Node.js 18+ (CI uses 22) Optional Only needed to build the web UI, desktop app (Tauri), or the browser extension
Rust 1.90+ Optional Only needed when building from source, to compile the native nova_ai_rust extension (maturin). PyPI wheels bundle the compiled extension, so pip install nova-ai-pro needs no Rust
uv latest Recommended Fast Python env manager; auto-installed by start.sh and the installers
Ollama latest Optional Local model server. Without it, use in-process GGUF models or cloud APIs
Git any recent Recommended Needed to clone the repo; checked by the installers
Tesseract OCR 5.x Optional Only for nova screen text extraction (UB-Mannheim build on Windows; tesseract-ocr on Linux, brew install tesseract on macOS)
Docker 24+ Optional Only for the containerized deployment (deploy/docker/)

Hardware: any 64-bit Windows 10/11, macOS 12+, or modern Linux. 4 GB RAM minimum, 16 GB+ recommended. A CUDA/Metal/ROCm GPU or Apple Silicon is optional but makes 7–8B models much faster. Small models (0.5–3B) run fine on CPU.

Quick Start (from source)

The fastest way to a running system from a fresh clone:

git clone https://github.com/Hamza35779/NOVA-AI.git
cd NOVA-AI
./start.sh          # Linux / macOS — interactive launcher (Windows: start.bat)

start.sh / start.bat check Python, then give you a menu: chat, voice, web server, memory wiki, diagnostics, and (on Windows) the opencode wizard. If you prefer to set things up manually, see Install from source below.

One-command everything (installs uv/Ollama if missing, pulls a starter model, builds the UI, starts backend + frontend, opens the browser): ./scripts/quickstart.sh

Install from source

1. Get the code and Python deps

git clone https://github.com/Hamza35779/NOVA-AI.git
cd NOVA-AI

# With uv (recommended):
uv sync --extra server --extra tools-search

# Or with plain pip (virtualenv recommended):
python -m venv .venv && source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install -e ".[server,tools-search]"

Windows note on inference-gguf: the in-process GGUF engine extra (--extra inference-gguf) compiles llama-cpp-python from source and needs Visual Studio Build Tools (C++ workload) + CMake. Without them uv sync / pip install fails inside its CMake step. Skip that extra (use Ollama or the cloud engines), or install the build tools first — prebuilt Windows wheels are not published.

Extra groups (install only what you need): dev (pytest/ruff/mypy/maturin), desktop (server + speech), server (FastAPI backend), inference-gguf (in-process GGUF, no Ollama needed — see the Windows note above), inference-vllm, inference-cloud, inference-litellm, memory-faiss / memory-pdf / memory-bm25, voice, screen, channel-telegram, and more — see [project.optional-dependencies] in pyproject.toml.

The storage/memory layer is faster with the compiled nova_ai_rust extension and some server APIs require it:

# Needs Rust 1.90+ (rustup installs it automatically from rust/rust-toolchain.toml)
uv run maturin develop --manifest-path rust/crates/nova_ai-python/Cargo.toml

3. Build the web UI

The built UI is not committed — nova serve serves it from src/nova_ai/server/static/, which is generated by the frontend build:

cd frontend
npm install
npm run build
cd ..

4. Verify and run

uv run nova doctor      # hardware, GPU, and engine health check
uv run nova serve       # web UI + API at http://localhost:8000

Then open http://localhost:8000. The in-app GGUF Hub can download a starter model with one click — no Ollama required.

5. Connect a model engine (pick one)

Option Setup Best for
In-process GGUF (zero setup) Nothing — use the GGUF Hub in the web UI, or drop a .gguf file into ~/.nova_ai/models/ Fully offline, no extra services
Ollama Install Ollama, then ollama serve and ollama pull qwen2.5:7b Easiest local model management
Cloud APIs Export OPENAI_API_KEY / ANTHROPIC_API_KEY / GEMINI_API_KEY / GROQ_API_KEY, or set them in the web UI Settings page Maximum capability
vLLM uv sync --extra inference-vllm, run a vLLM OpenAI-compatible server, point NOVA AI at it GPU servers, batch throughput

Running nova init writes ~/.nova_ai/config.toml with hardware-detected defaults (or start from a template in configs/nova_ai/config.toml).

Uninstalling

Source installs live entirely inside the cloned folder plus ~/.nova_ai/:

# Remove the checkout (deactivates the CLI / uv environments)
cd .. && rm -rf NOVA-AI

# Remove user data: config, databases, downloaded GGUF models
rm -rf ~/.nova_ai        # Windows (PowerShell): Remove-Item -Recurse ~\.nova_ai

# Optional extras you may have installed along the way:
#   uv:        rm -rf ~/.local/share/uv ~/.cargo/bin/uv
#   Ollama:    use the platform uninstaller, or `brew uninstall ollama`
#   Rust:      rustup self uninstall

The curl/one-line installer variant ships an uninstaller: nova-uninstall (sees scripts/install/nova-uninstall.sh). There is no pip uninstall nova-ai step needed for source installs; for the PyPI package use pip uninstall nova-ai-pro.

Why NOVA AI?

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. Local language models already handle most single-turn chat and reasoning queries, and their capability per watt keeps improving year over year. What has been missing is the software stack to make local-first personal AI practical.

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

Installation & Quick Start

Pick your platform and start in seconds:

Platform Quick Launch Installation One-liner
Windows (Desktop installer) Double-click NOVA.AI_1.2.7_x64-setup.exe — desktop GUI incl. Alt+Space Quick Capture; for the no-Python full backend use the portable zip Latest Release
Windows (1-Click) Double-click start.bat irm https://raw.githubusercontent.com/Hamza35779/NOVA-AI/main/deploy/windows/install.ps1 | iex or run install.bat
Linux · macOS ./start.sh curl -fsSL https://raw.githubusercontent.com/Hamza35779/NOVA-AI/main/scripts/install/install.sh | bash
Docker cp deploy/docker/.env.example .env # fill NOVA_AI_API_KEY then docker compose -f deploy/docker/docker-compose.yml --env-file .env up Containerized setup with local Ollama engine
Desktop GUI Download .exe / .dmg / .AppImage Latest Release

Start Working with NOVA AI

# Interactive Chat
nova chat

# Hands-free Voice Conversation
nova voice --push-to-talk

# Smart Model Router (Auto-selects optimal model)
nova router status
nova router test "Analyze quantum algorithms"

# Active Memory Wiki
nova memory-wiki show profile
nova memory-wiki search "preferences"

# Interactive Canvas (Open HTML/SVG/Chart visualizations)
nova canvas list

# Build/Test Diagnostics with Self-Healing Fix Suggestions
nova dev-watch -c "pytest -q"

# Presets & System Diagnostics
nova init --preset morning-digest-minimal
nova doctor

Prefix nova ... with uv run, or source .venv/bin/activate first.

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:

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

Per-preset deep dives: morning digest · deep research · code assistant · scheduled monitor · chat simple · or the full quickstart guide.

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.

# Install skills from public sources
nova skill install hermes:arxiv
nova skill sync hermes --category research

# Use skills with any agent
nova 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
nova optimize skills --policy dspy

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

Import from Hermes Agent (~150 skills), OpenClaw (~13,700 community skills), or any GitHub repo. Skills follow the agentskills.io open standard.

See the Skills User Guide and Skills Tutorial for details.

Built-in Agents

NOVA AI ships with 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 and a desktop notification when ready
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
self_healing_react On-demand ReAct with a bounded self-repair loop — powers nova dev-watch diagnostics
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

opencode Integration

Use opencode with NOVA AI in both directions — opencode gets your local Ollama models (as the nova-ai provider) and NOVA's tool registry via MCP, so coding-agent sessions run local-first:

nova opencode install   # fetch the opencode CLI when missing
nova opencode init      # write/merge ./opencode.json (provider + MCP tools)
nova serve              # start the backend (another terminal)
nova opencode launch    # open opencode wired to NOVA AI

nova opencode status shows per-provider data residency (local vs cloud); --local-only locks opencode to local models and disables session sharing. Docs: opencode Integration.

Desktop Extras

  • ⚡ Quick Capture (Windows: Alt+Space, macOS: Cmd+Shift+Space) — a Raycast-style chat popup from anywhere; the conversation syncs back to the main app automatically.
  • 🔔 Morning digest notifications — a desktop notification fires the moment your briefing is stored (covers scheduler, CLI, and server delivery); nova digest plays audio on Windows via winsound/the default media player.
  • 🔨 Dev-Watch — run a build/test command, get failure classification (timeout / exit code / embedded errors) plus self-healing fix suggestions; results feed the Build Diagnostics panel on the Dashboard (/api/devwatch/runs).

Complete CLI Commands Reference

NOVA AI features a comprehensive CLI suite (nova or python -m nova_ai.cli or standalone nova-ai.exe):

1. 💬 Chat, Voice & Perception

Command Description Example
nova chat Launch an interactive multi-turn REPL chat session nova chat --model llama3
nova ask "<query>" Send a single query directly to the model/agent nova ask "Summarize this repo"
nova voice Real-time hands-free voice conversation mode nova voice --push-to-talk
nova screen capture Capture active window/screen and run OCR text extraction nova screen capture --output screen.png
nova screen ask "<query>" Ask questions about what's currently on your screen nova screen ask "Explain this error"

2. 🚀 Server & Background Daemons

Command Description Example
nova serve Start the local OpenAI-compatible REST & WebSocket API server nova serve --port 8000
nova start Start the NOVA AI server as a background daemon process nova start
nova status Check status of the running background daemon nova status
nova restart Restart the running server daemon nova restart
nova stop Terminate the server background daemon nova stop
nova tunnel Expose local API securely to the internet via Cloudflare Tunnel nova tunnel --port 8000 (starts; nova tunnel status inspects config)

3. 🧠 Models & Smart Routing

Command Description Example
nova model list List all discovered local and cloud AI models nova model list
nova model pull <name> Download a local GGUF/Ollama model directly nova model pull llama3
nova host <model> Serve and host a local model with hardware acceleration nova host qwen2.5:7b
nova router status View the Smart Router complexity tiers & statistics nova router status
nova router test "<query>" Test dynamic query complexity classification nova router test "Design a microservice"

4. 🛠️ Autonomous Tools & Integrations

Command Description Example
nova tool list List all registered built-in and dynamic tools nova tool list
nova integrations list View software connectors (Packet Tracer, Office, Canvas, Git) nova integrations list
nova integrations enable <id> Enable a specific software bridge nova integrations enable cisco_packet_tracer
nova canvas list List interactive Canvas charts, HTML, and SVG artifacts nova canvas list
nova scheduler list View and manage scheduled tasks and cron jobs nova scheduler list
nova add <mcp-server> Connect external Model Context Protocol (MCP) servers nova add filesystem
nova tool list List registered tools with descriptions nova tool list

5. 📚 Long-Term Memory & Deep Research

Command Description Example
nova memory status Inspect SQLite vector store and indexed chunk counts nova memory status
nova memory search "<q>" Semantic search over indexed personal knowledge base nova memory search "project plan"
nova memory-wiki show <topic> Display structured markdown knowledge-base articles nova memory-wiki show profile
nova research Auto-detect local sources, ingest, and launch Deep Research chat (use nova ask --research "<topic>" for one-shot cited research) nova ask --research "Latest advancements in LLM reasoning"

6. ⚙️ Diagnostics, Config & Benchmarking

Command Description Example
nova doctor Run full hardware, GPU, and engine health diagnostics nova doctor
nova logs Show server/CLI log files (-f to follow) nova logs -f server.log
nova dev-watch -c "<cmd>" Run a build/test command and self-diagnose failures with fix suggestions nova dev-watch -c "pytest -q" --watch
nova init Auto-detect GPU hardware and create ~/.nova_ai/config.toml nova init --preset deep-research
nova config show Print loaded configuration hierarchy and settings nova config show
nova config set <k> <v> Modify a configuration property in TOML nova config set engine.default ollama
nova bench Measure inference latency, tokens/sec, and energy consumption nova bench run --model llama3
nova self-update Upgrade NOVA AI to the latest release nova self-update

See the User Guide and Tutorials for detailed setup instructions.

Full documentation — including Docker deployment, cloud engines, development setup, and tutorials — at hamza35779.github.io/NOVA-AI.

Community

Contributing

We welcome contributions! See the Contributing Guide for incentives, contribution types, and the PR process.

Quick start for contributors:

git clone https://github.com/Hamza35779/NOVA-AI.git
cd NOVA-AI
uv sync --extra dev --extra framework-comparison --extra server
uv run maturin develop --manifest-path rust/crates/nova_ai-python/Cargo.toml   # native extension (CI builds it too)
cd frontend && npm ci && npm run build && cd ..                                # embeds the UI into nova serve
uv run pre-commit install
uv run pytest tests/ -v

Useful scripts: scripts/gen-cli-docs.py regenerates docs/cli/ from nova --help, and scripts/check-versions.sh catches stale installer/version strings before CI does.

Browse the Roadmap for areas where help is needed. Comment "take" on any issue to get auto-assigned.

License

Apache 2.0

Release files for nova-ai-pro 1.2.8.dev124

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nova-ai-pro 1.2.8.dev124
File Size Uploaded
nova_ai_pro-1.2.8.dev124.tar.gz 13.8 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for nova-ai-pro 1.2.8.dev124
File Interpreter ABI Platform
nova_ai_pro-1.2.8.dev124-py3-none-any.whl Python 3 none any Details

Total release size: 16.1 MB

Release files / nova_ai_pro-1.2.8.dev124.tar.gz

Download URL nova_ai_pro-1.2.8.dev124.tar.gz
Size 13.8 MB
Tags Source
SHA-256 checksum
How to use checksums
6ca48a0f5740c9dbc0bbfda2681694b5e3062edf87171ef6977e3c014c703c36
BLAKE2b-256 checksum
How to use checksums
f53b91a6d271f2647c0690e416a51c59533bbdd93007f4567ead58bc4f401a0b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / nova_ai_pro-1.2.8.dev124-py3-none-any.whl

Download URL nova_ai_pro-1.2.8.dev124-py3-none-any.whl
Size 2.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
fb378678c874899261f7fab24bacb73b10eb891f5d3904d88b88e302cb7590cc
BLAKE2b-256 checksum
How to use checksums
75807228825c2e83e0e5becbba5acdff31cd8b4858a244c75641c17bbfd7e1a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

1.2.8

2 release files

This release

1.2.8.dev124 This release

2 release files

1.2.7

2 release files

1.2.6

2 release files

1.2.5

2 release files

1.2.4

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page