User Guide
Also available: Markdown Β· Plain text
User Guide β Gnomad Desktop Assistant
Version: 0.2.0-beta.1
Project site: davidthegnomad.github.io/gnomad-desktop-assistant
Studio: gnomadstudio.org
Introduction
Gnomad is a desktop AI assistant that lives in your menu bar (macOS) or system tray (Windows/Linux). It can:
- Chat using cloud (DeepSeek) or local (Ollama) models
- See your active app, window title, and clipboard (footer context strip)
- Run real shell commands and file operations in a controlled workspace
- Store skills and reference documents in a knowledge library
Closing the window hides Gnomad to the trayβit does not quit the app unless you choose Quit from the tray menu.
Installation
macOS
- Download the
.dmgfrom GitHub Releases or the project site - Drag Gnomad to Applications
- First open: right-click β Open if Gatekeeper blocks unsigned alpha builds
Windows
- Run the
.msiorsetup.exeinstaller - Launch from Start Menu; allow tray icon if prompted
Linux
- Debian/Ubuntu:
sudo apt install ./gnomad_*_amd64.deb - Fedora/RHEL:
sudo dnf install ./gnomad-*-1.x86_64.rpm - Other:
chmod +x gnomad_*.AppImage&& run it
See LINUX_PACKAGES.md for distro-specific details.
First launch & onboarding
On first launch (when no API key and no Ollama URL are configured), a welcome wizard appears:
- Choose provider β Cloud API (DeepSeek) or Local model (Ollama)
- Configure β API key + model, or Ollama URL + model tag
Keys are saved to your system keychain. Change setup anytime in Settings β Re-run setup wizard.
Developers may use .env with DeepSeek_API_KEY; the UI shows Set from .env and locks that key slot.
Opening and closing Gnomad
| Action | macOS | Windows / Linux |
|---|---|---|
| Show / hide | Menu bar icon or ββ§Space | Tray icon or Ctrl+Shift+Space |
| Hide window | Close button or shortcut again | Same |
| Quit | Tray β Quit Gnomad | Same |
Tray menu: Show Gnomad, Pop Out Window, Settings, Visit gnomadstudio.org, About, Quit.
Window modes
Use the four chips in the title bar (or View menu in windowed mode):
| Mode | Description |
|---|---|
| Panel | Drops from menu bar / near tray; compact layout |
| Pop out | Floating, movable window |
| Window | Standard window with native menus |
| Full | Fullscreen; click again to return to pop out |
Main interface overview
Title bar: Window modes, theme toggle, Knowledge (book), Settings (gear).
Sidebar: New chat, history, knowledge shortcut; resize, collapse, flip side.
Center: Welcome, suggestion chips, messages, shell output blocks.
Composer: Input, attachments, terminal (local), provider/model, send.
Context footer: Active app, window title, clipboard, permission banner (macOS).
Chat & composer
- Type or click a suggestion chip
- Optionally attach files
- Choose Cloud/Local and model
- Press Send or Enter
While thinking: Click Stop to interrupt shell activity.
Direct shell (local): Prefix with $ or use the terminal icon.
Cloud vs local AI
| Cloud (DeepSeek) | Local (Ollama) | |
|---|---|---|
| Requires | API key | Ollama URL + running server |
| Models | Chat, Reasoner | llama3.2, mistral, custom tags |
| Agent | Tool calling | <gnomad-run> tags + optional planner |
| Network | Internet | Usually localhost |
Switch via composer or Settings β Model & API.
Changing models and API keys
Composer: Provider and model dropdowns.
Settings β Model & API: Cloud model or Ollama URL + model name.
Settings β API keys: Add/change/remove DeepSeek key (keychain). .env keys are locked in UI.
Agent: shell & filesystem
- Cloud: Tools for shell, files, workspace (up to 10 steps per message)
- Local:
gnomad-runtags,$commands, optional command planner - Shell session: Persistent cwd; reset in Settings β Agent shell
- Workspace: Settings β Agent access β Change folder
- Trust: Standard (workspace + gates) or YOLO (broader FS)
- Audit:
{app_data}/gnomad/agent-audit.jsonl
Safety: Sudo Gate & Path Gate
Sudo Gate β Risky shell (sudo, rm -rf, etc.): read reason, Approve or Deny. Approval mints a signed HITL token bound to the exact command (single-use, ~2 min TTL). Passing approval without a token is rejected.
Path Gate β Standard mode: files outside workspace need approval. Allow once mints a signed path token bound to the canonical path and scope (read/write).
Embedded GGUF (optional build)
When built with embedded-llm (npm run tauri:dev:embedded):
- Settings β Agent access β GGUF path β point to a small
.gguf(e.g. Qwen2.5-Coder 1.5B Q4) - Command planner uses GGUF in-process (no Ollama required for planner)
- Experimental β Use GGUF for local chat β full local chat without Ollama
- Experimental β Sandbox shell in YOLO β wrap shell in OS sandbox (macOS/Linux)
Terminal view (xterm.js)
While the agent runs commands, live PTY output streams in the thinking panel. On command cards, click Terminal view to replay ANSI-colored output in an embedded terminal.
Updates
Settings β Updates β choose Stable or Beta channel, then Check for updates. Requires signed release artifacts; see UPDATER.md.
Knowledge & skills library
Open via book icon or sidebar. Folders under gnomad/knowledge/:
skills/β instructions (.md,.txt,.json)agents/β personaspreferences/β user preferencesuploads/β reference files
Add files in the panel; INDEX.md updates automatically.
Chat history & sidebar
- New chat: Sidebar + or β/Ctrl+N
- Select / delete sessions in the list
- Layout: Resize, collapse, drag to flip side
Sessions stored locally on disk.
Settings reference
| Section | Purpose |
|---|---|
| Model & API | Provider, models, wizard |
| API keys | Keychain secrets |
| Agent access | Workspace, trust, planner, GGUF, experimental flags |
| Updates | Stable/beta channel, check/install |
| Agent shell | CWD, reset session |
| Knowledge | Open library |
| Permissions | Accessibility, elevation test; Wayland tray hint |
Theme: Sun/moon/monitor icon cycles Light β Dark β System.
Voice input (beta)
- Settings β Privacy β Enable microphone dictation
- Click the mic button in the composer (push-to-talk β click again to stop)
- Speech is converted to text by your OS/browser engine and appended to the message
Audio may be processed by Apple, Google, or another vendor depending on platform β not sent to Gnomad servers. Disable anytime in Settings.
Keyboard shortcuts
| Shortcut | Action |
|---|---|
| ββ§Space / Ctrl+Shift+Space | Show / hide |
| βN / Ctrl+N | New chat |
| β, / Ctrl+, | Settings |
| βQ / Ctrl+Q | Quit (windowed) |
Platform-specific notes
macOS: Accessibility for automation; admin auth for elevation.
Windows: Tray near notification area; elevated cmds in admin terminal.
Linux: WebKitGTK + AppIndicator; optional xdotool, wl-paste, xclip. On Wayland, left-click the tray icon to open the menu (Settings shows a hint when Wayland is detected).
Troubleshooting
See TROUBLESHOOTING.md for the full guide. Quick fixes:
| Issue | Fix |
|---|---|
| Cloud disabled | Add API key, or set DeepSeek_API_KEY / OPENAI_API_KEY in .env |
| Local disabled | Set Ollama URL; run ollama serve |
| Chat errors | Check network, cloud endpoint in Settings, or curl Ollama URL |
| No tray (Linux) | Install appindicator packages |
| Empty context (Linux) | Install clipboard/window tools |
| macOS permissions | Re-grant Accessibility after updates |
Privacy & data
- Chat and knowledge stay on your device
- Cloud prompts go to DeepSeek per their terms
- Local prompts go to your Ollama server
- API keys in OS keychain
- Clipboard included only when you send a message
See PRIVACY.md for the full policy.
Built with β€οΈ by Gnomad Studio π¦