Skip to main content

NixOrb v2.0 🌐

Floating AI assistant orb for Arch Linux — KDE Plasma 6 Wayland — Local-Only

A complete ground-up remake of NixOrb with a focus on local AI, rock-solid Qt6 stability, and clean modular architecture.


What's New in v2.0

  • Local-only AI — Ollama backend, no API keys needed
  • Fixed Qt errors — Proper qasync integration, QSocketNotifier fixes, accessibility bridge disabled
  • Simplified architecture — Removed broken backends, focused on what works
  • Better VRAM management — Priority eviction keeps GTX 1080 from OOM
  • Offline TTS — Piper + espeak-ng fallback
  • Improved settings — GUI settings editor with live updates

Architecture Overview

NixOrb Architecture Pipeline

Quick Start

Install (Arch Linux)

git clone https://github.com/minerofthesoal/nixorb.git
cd nixorb
chmod +x install.sh
./install.sh

Start NixOrb

nixorb start          # Launch the floating orb
nixorb trigger        # Activate the running orb (bind to a KDE shortcut)
nixorb status         # Check system status
nixorb quit           # Shut the running orb down
nixorb ask "What is 2+2?"   # One-shot query
nixorb check          # Check dependencies

nixorb trigger talks to the running instance over a Unix socket in $XDG_RUNTIME_DIR, so it works the same under Wayland, X11, or a bare TTY — which is what makes it usable as a KDE global shortcut.

Pipeline Flow

Trigger (Hotkey/WakeWord/Click)
  → Record Audio (sounddevice + VAD)
  → Transcribe (faster-whisper INT8, ~2.1GB VRAM)
  → Think (Ollama LLM stream, localhost:11434)
  → Speak (Piper TTS, offline)
  → Execute (<ACTION> sandboxed bash)

VRAM Budget (GTX 1080 8GB)

Component VRAM Priority
Whisper Large v3 INT8 ~2.1 GB LOW — evicted first
Ollama LLM (loaded by Ollama) ~4.0 GB HIGH
Piper TTS ~0.1 GB MEDIUM
System + KDE ~0.5 GB reserved
Safety buffer 0.25 GB reserved

Configuration

Edit ~/.config/nixorb/config.toml or use the GUI (right-click orb → Settings):

hotkey = "Ctrl+Alt+Space"
orb_size = 88
llm_model = "llama3.2"
ollama_host = "http://localhost:11434"
tts_backend = "piper"

# Requires the optional extra: pip install 'nixorb[wakeword]'
wake_word_enabled = false

# Ask before running every command the model emits.
require_action_confirmation = true

See config/default.toml for every option with comments.

Orb States

The orb has no caption — its colour is the state, and the tray tooltip spells it out in words.

State Colour Meaning
Idle Clay #C96442 Waiting for you
Listening Sage #5E9C7E Recording; the ring tracks your voice
Thinking Amber #D9A441 Querying the model
Speaking Lit clay #E08A62 Talking back
Error Rust #B3453E Something failed — check the log

Keyboard Shortcuts

Action Default Notes
Activate Ctrl+Alt+Space Global hotkey (via pynput/XWayland)
KDE Shortcut Custom System Settings → Shortcuts, running nixorb trigger
Orb double-click Double-click Direct activation
Orb right-click Right-click Menu: Activate / Settings / Quit
Opacity Scroll wheel While hovering over orb
Drag Click+drag Reposition the orb

Project Structure

nixorb/
├── core/           # Event bus, VRAM manager
├── asr/            # Whisper speech-to-text + wake word
├── llm/            # Ollama local LLM backend
├── tts/            # Piper text-to-speech
├── ui/             # Qt6 UI (orb, tray, settings, hotkey)
├── action/         # Sandboxed command execution + clipboard
├── memory/         # ChromaDB vector memory
├── plugins/        # Plugin loader
├── utils/          # Paths, logging, web search
├── vision/         # Screen capture
├── main.py         # Entry point
├── cli.py          # CLI interface
└── settings.py     # Configuration

Dependencies

  • System: python 3.12+, qt6-base, qt6-declarative, qt6-wayland, portaudio, wl-clipboard, grim, ollama
  • AUR: piper-tts (speech). Note its binary is piper-tts — Arch's piper package is the unrelated gaming-mouse tool. espeak-ng is the fallback if Piper is missing.
  • Python: See requirements.txt / pyproject.toml

Troubleshooting

NixOrb writes everything it does to ~/.local/share/nixorb/logs/nixorb.log. Start with nixorb status — it reports whether Ollama is actually reachable and whether the configured model is installed.

Symptom Check
Orb never appears qt6-declarative and qt6-wayland installed? The log prints any QML error.
nixorb: command not found ~/.local/bin on your PATH (the installer links it there).
Orb appears, nothing happens on activate nixorb status — Ollama unreachable, or the model isn't pulled.
It speaks no audio yay -S piper-tts (AUR), or install espeak-ng; the log says which is missing.
nixorb trigger says not running Start the orb first; nixorb status shows the control socket.
Commands are always denied Approve the confirmation dialog, or set require_action_confirmation = false.
Actions do nothing when run as root NixOrb disables command execution as root — run it as your normal user.

Testing

pip install -e ".[dev]"
pytest tests/ -v

License

MIT © NixOrb Contributors

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nixorb-0.3.2.tar.gz (180.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nixorb-0.3.2-py3-none-any.whl (120.9 kB view details)

Uploaded Python 3

File details

Details for the file nixorb-0.3.2.tar.gz.

File metadata

  • Download URL: nixorb-0.3.2.tar.gz
  • Upload date:
  • Size: 180.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nixorb-0.3.2.tar.gz
Algorithm Hash digest
SHA256 9275b87ceeac306eeab726931dbfa6382e7b630d3932ec863520e51dc7fcd720
MD5 761e77020426e94a92a8e655517c1297
BLAKE2b-256 ea02cb90985110b9b73cae70aa8a12cb1c4ed9f7b537b1432aea7dc78380adf0

See more details on using hashes here.

Provenance

The following attestation bundles were made for nixorb-0.3.2.tar.gz:

Publisher: release.yml on minerofthesoal/nixorb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nixorb-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: nixorb-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 120.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for nixorb-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a7e1b4fa9dc2e744f71b3e9d4501d1901cd5c4a08460d830474b6cfd07e1c20e
MD5 781f3a738f1c801451b85dde42d5a165
BLAKE2b-256 abd5d754e71779c7f7b5d791499795251743ad091d5b864860b13096765697b6

See more details on using hashes here.

Provenance

The following attestation bundles were made for nixorb-0.3.2-py3-none-any.whl:

Publisher: release.yml on minerofthesoal/nixorb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.3.4

2 files

0.3.3

2 files

This release

0.3.2 This release

2 files

0.3.1

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0.10

2 files

0.1.0.9

2 files

0.1.0.8

2 files

0.1.0.7

2 files

0.1.0.5

2 files

0.1.0.4

2 files

0.1.0.1

2 files

0.1.0

2 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