guaardvark 2.6.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. guaardvark-2.6.0/PKG-INFO +416 -0
  2. guaardvark-2.6.0/guaardvark.egg-info/PKG-INFO +416 -0
  3. guaardvark-2.6.0/guaardvark.egg-info/SOURCES.txt +51 -0
  4. guaardvark-2.6.0/guaardvark.egg-info/dependency_links.txt +1 -0
  5. guaardvark-2.6.0/guaardvark.egg-info/entry_points.txt +2 -0
  6. guaardvark-2.6.0/guaardvark.egg-info/requires.txt +14 -0
  7. guaardvark-2.6.0/guaardvark.egg-info/top_level.txt +2 -0
  8. guaardvark-2.6.0/llx/__init__.py +1 -0
  9. guaardvark-2.6.0/llx/client.py +155 -0
  10. guaardvark-2.6.0/llx/commands/__init__.py +1 -0
  11. guaardvark-2.6.0/llx/commands/agents.py +180 -0
  12. guaardvark-2.6.0/llx/commands/backup.py +195 -0
  13. guaardvark-2.6.0/llx/commands/chat.py +321 -0
  14. guaardvark-2.6.0/llx/commands/clients.py +118 -0
  15. guaardvark-2.6.0/llx/commands/dashboard.py +155 -0
  16. guaardvark-2.6.0/llx/commands/family.py +204 -0
  17. guaardvark-2.6.0/llx/commands/files.py +176 -0
  18. guaardvark-2.6.0/llx/commands/generate.py +84 -0
  19. guaardvark-2.6.0/llx/commands/images.py +158 -0
  20. guaardvark-2.6.0/llx/commands/index.py +119 -0
  21. guaardvark-2.6.0/llx/commands/jobs.py +146 -0
  22. guaardvark-2.6.0/llx/commands/launch.py +145 -0
  23. guaardvark-2.6.0/llx/commands/logs.py +219 -0
  24. guaardvark-2.6.0/llx/commands/projects.py +121 -0
  25. guaardvark-2.6.0/llx/commands/rag.py +202 -0
  26. guaardvark-2.6.0/llx/commands/rules.py +144 -0
  27. guaardvark-2.6.0/llx/commands/search.py +44 -0
  28. guaardvark-2.6.0/llx/commands/settings.py +93 -0
  29. guaardvark-2.6.0/llx/commands/system.py +277 -0
  30. guaardvark-2.6.0/llx/commands/tasks.py +193 -0
  31. guaardvark-2.6.0/llx/commands/videos.py +379 -0
  32. guaardvark-2.6.0/llx/commands/websites.py +150 -0
  33. guaardvark-2.6.0/llx/completer.py +195 -0
  34. guaardvark-2.6.0/llx/config.py +210 -0
  35. guaardvark-2.6.0/llx/context.py +276 -0
  36. guaardvark-2.6.0/llx/global_opts.py +48 -0
  37. guaardvark-2.6.0/llx/launch_config.py +100 -0
  38. guaardvark-2.6.0/llx/lite_server.py +137 -0
  39. guaardvark-2.6.0/llx/main.py +102 -0
  40. guaardvark-2.6.0/llx/onboarding.py +160 -0
  41. guaardvark-2.6.0/llx/output.py +106 -0
  42. guaardvark-2.6.0/llx/repl.py +352 -0
  43. guaardvark-2.6.0/llx/slash.py +737 -0
  44. guaardvark-2.6.0/llx/streaming.py +517 -0
  45. guaardvark-2.6.0/llx/theme.py +517 -0
  46. guaardvark-2.6.0/llx/utils.py +34 -0
  47. guaardvark-2.6.0/setup.cfg +4 -0
  48. guaardvark-2.6.0/setup.py +67 -0
  49. guaardvark-2.6.0/tests/__init__.py +0 -0
  50. guaardvark-2.6.0/tests/test_launch_config.py +86 -0
  51. guaardvark-2.6.0/tests/test_lite_server.py +105 -0
  52. guaardvark-2.6.0/tests/test_onboarding.py +86 -0
  53. guaardvark-2.6.0/tests/test_slash_multimodal.py +85 -0
@@ -0,0 +1,416 @@
1
+ Metadata-Version: 2.4
2
+ Name: guaardvark
3
+ Version: 2.6.0
4
+ Summary: Guaardvark CLI — full-stack AI platform with RAG, image/video generation, and agents
5
+ Home-page: https://guaardvark.com
6
+ Author: Guaardvark
7
+ Project-URL: Source, https://github.com/guaardvark/guaardvark
8
+ Project-URL: Homepage, https://guaardvark.com
9
+ Project-URL: Issues, https://github.com/guaardvark/guaardvark/issues
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Environment :: Console
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
15
+ Requires-Python: >=3.12
16
+ Description-Content-Type: text/markdown
17
+ Requires-Dist: typer[all]>=0.9.0
18
+ Requires-Dist: rich>=13.0.0
19
+ Requires-Dist: python-socketio>=5.10.0
20
+ Requires-Dist: httpx>=0.25.0
21
+ Requires-Dist: websocket-client>=1.6.0
22
+ Requires-Dist: requests>=2.31.0
23
+ Requires-Dist: prompt_toolkit>=3.0.0
24
+ Requires-Dist: tenacity>=8.0.0
25
+ Requires-Dist: flask>=3.0.0
26
+ Provides-Extra: rag
27
+ Requires-Dist: llama-index-core<0.15.0,>=0.13.0; extra == "rag"
28
+ Requires-Dist: llama-index-llms-ollama>=0.7.0; extra == "rag"
29
+ Requires-Dist: llama-index-embeddings-ollama>=0.8.0; extra == "rag"
30
+ Dynamic: author
31
+ Dynamic: classifier
32
+ Dynamic: description
33
+ Dynamic: description-content-type
34
+ Dynamic: home-page
35
+ Dynamic: project-url
36
+ Dynamic: provides-extra
37
+ Dynamic: requires-dist
38
+ Dynamic: requires-python
39
+ Dynamic: summary
40
+
41
+ # Guaardvark
42
+
43
+ **Version 2.6.0** · [guaardvark.com](https://guaardvark.com)
44
+
45
+ The self-hosted AI workstation. Autonomous agents that see your screen and control your apps. A three-tier neural routing engine. Parallel agent swarms across isolated git worktrees. Video generation, image upscaling to 4K/8K, RAG over your documents, voice interface, and a 57-tool execution engine — all running locally on your hardware. Your machine. Your data. Your rules.
46
+
47
+ <p align="center">
48
+ <img src="https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/guaardvark-demo.gif" alt="Guaardvark Demo" width="100%">
49
+ </p>
50
+
51
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
52
+ [![CI](https://github.com/guaardvark/guaardvark/actions/workflows/ci.yml/badge.svg)](https://github.com/guaardvark/guaardvark/actions/workflows/ci.yml)
53
+ [![PyPI](https://img.shields.io/pypi/v/guaardvark?label=PyPI&color=blue)](https://pypi.org/project/guaardvark/)
54
+ [![GitHub stars](https://img.shields.io/github/stars/guaardvark/guaardvark?style=social)](https://github.com/guaardvark/guaardvark/stargazers)
55
+ [![GitHub issues](https://img.shields.io/github/issues/guaardvark/guaardvark)](https://github.com/guaardvark/guaardvark/issues)
56
+ [![Sponsor](https://img.shields.io/badge/Sponsor-Guaardvark-ff69b4?logo=github-sponsors)](https://github.com/sponsors/guaardvark)
57
+
58
+ ```bash
59
+ git clone https://github.com/guaardvark/guaardvark.git && cd guaardvark && ./start.sh
60
+ ```
61
+
62
+ One command. Installs everything. Starts all services. Done.
63
+
64
+ ### AI-Generated Film — Made Entirely with Guaardvark
65
+
66
+ Every frame generated on a single desktop GPU. No cloud. No stock footage. No API keys.
67
+
68
+ [![Gotham Rising — AI-Generated Short Film](https://img.youtube.com/vi/8MdtM3HurJo/maxresdefault.jpg)](https://www.youtube.com/watch?v=8MdtM3HurJo)
69
+
70
+ ---
71
+
72
+ ## What Makes This Different
73
+
74
+ ### AgentBrain — Three-Tier Neural Routing
75
+
76
+ Every message is routed through a three-tier decision engine that picks the fastest path to the right answer. Reflexes fire in under a millisecond. Instinct handles single-shot requests in one LLM call. Deliberation spins up a full ReACT reasoning loop when the problem demands it.
77
+
78
+ | Agent Control | Agent Tools |
79
+ |:-:|:-:|
80
+ | ![Agents](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/agents-page.png) | ![Tools](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/agent-tools-page.png) |
81
+
82
+ | Tier | Name | Latency | LLM Calls | When It Fires |
83
+ |------|------|---------|-----------|---------------|
84
+ | 1 | **Reflex** | <100ms | 0 | Greetings, farewells, media controls — pattern-matched, no inference |
85
+ | 2 | **Instinct** | 1–3s | 1 | Single-shot questions, web searches, image generation, vision tasks |
86
+ | 3 | **Deliberation** | 5–30s | 3–10 | Multi-step research, analysis chains, complex agent tasks |
87
+
88
+ - **Automatic escalation** — Tier 2 can signal complexity and hand off to Tier 3 mid-response
89
+ - **Agent-screen gating** — when the virtual screen isn't being viewed, vision models fall through to the normal ReACT loop with the full tool registry instead of always trying to drive the screen. Click and type tools only appear when a user actually has the agent screen open.
90
+ - **BrainState singleton** — pre-computes tool schemas, model capabilities, system prompts, and reflex tables at startup so routing adds zero overhead
91
+ - **Warm-up** — background thread loads the active model into VRAM before the first request arrives
92
+
93
+ ### Autonomous Screen Agents
94
+
95
+ Guaardvark agents control a real virtual desktop (Xvfb + openbox at 1280x720). They see the screen through vision models, move the mouse, click buttons, type text, navigate browsers, and verify their own actions.
96
+
97
+ - **Unified vision brain** — Gemma4 sees the screen and decides the next action in a single inference call. Qwen3-VL handles coordinate estimation. Both calibrated per-model with tracked scale factors.
98
+ - **Closed-loop servo targeting** — three-attempt adaptive strategy: ballistic move → single correction with crosshair overlay → full corrections with zoom-cropped analysis around the cursor
99
+ - **45+ deterministic recipes** — browser navigation, tabs, scroll, search, find, zoom, copy/paste — all execute instantly from a JSON recipe library, bypassing the vision loop entirely
100
+ - **Obstacle detection** — handles popups, permission dialogs, and notification bars with automatic thinking model escalation
101
+ - **Self-QA sweep** — agent navigates every page of its own UI and reports what's working and what's broken
102
+ - **Live agent monitor** — real-time SEE/THINK/ACT transcript of every decision the agent makes
103
+ - **Integrated screen viewer** — draggable, resizable VNC viewer on any page with popup window mode
104
+
105
+ #### Supported Vision Models
106
+
107
+ | Model | Role | Coordinate System | Notes |
108
+ |-------|------|-------------------|-------|
109
+ | Gemma4 (e4b) | Sees + decides | 1024x1024 normalized, box_2d `[y1,x1,y2,x2]` | Unified brain — vision and reasoning in one call |
110
+ | Qwen3-VL (2b) | Coordinate estimation | 1024px internal width | Default servo eyes, fast and accurate on dark UIs |
111
+ | Qwen3-VL (4b/8b) | Escalation eyes | 1024px internal width | Automatic escalation after 3 consecutive failures |
112
+ | Moondream | Fallback eyes | 1024px internal width | For text-only models that need external vision |
113
+
114
+ ### Swarm Orchestrator — Parallel Agent Execution
115
+
116
+ Launch multiple AI coding agents in parallel, each working in an isolated git worktree on its own branch. Results merge back with dependency-ordered conflict detection, optional test validation, and full cost tracking.
117
+
118
+ - **Two backends** — Claude Code (cloud, cost-tracked at $0.015/$0.075 per 1K tokens) and Cline/OpenClaw (fully local via Ollama, zero cost)
119
+ - **Flight Mode** — fully offline operation. Auto-detects network state, falls back to local models, serializes file conflicts automatically. No prompts, no internet required.
120
+ - **Git worktree isolation** — each task gets its own branch and working directory. All worktrees share the `.git` directory (lightweight). Automatically excluded from `git status`.
121
+ - **Dependency-aware merging** — topological sort ensures foundational changes land first. Dry-run conflict detection before real merge. Test suite validation before integration.
122
+ - **Built-in templates** — REST API scaffold, refactor-and-extract, test coverage expansion, Flight Mode demo
123
+ - **Up to 20 concurrent agents** — configurable limit with automatic slot management
124
+ - **Live dashboard** — real-time status, per-task logs, cost breakdown, elapsed time, disk usage
125
+
126
+ ### Video Generation Pipeline
127
+
128
+ State-of-the-art video generation running entirely on your GPU. No cloud APIs, no per-minute billing, no content restrictions.
129
+
130
+ | Video Generation | Plugin System |
131
+ |:-:|:-:|
132
+ | ![Video Gen](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/video-generation-page.png) | ![Plugins](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/plugins-page.png) |
133
+
134
+ | Model | Type | Max Duration | Native Resolution | VRAM |
135
+ |-------|------|-------------|-------------------|------|
136
+ | **Wan 2.2 (14B MoE)** | Text-to-Video | 5s (81 frames @ 16fps) | 832x480 | 11GB |
137
+ | **CogVideoX-5B** | Text-to-Video | 6s (49 frames @ 8fps) | 720x480 | 16GB |
138
+ | **CogVideoX-2B** | Text-to-Video | 6s (49 frames @ 8fps) | 720x480 | 12GB |
139
+ | **CogVideoX-5B I2V** | Image-to-Video | 6s (49 frames @ 8fps) | 720x480 | 16GB |
140
+ | **SVD XT** | Text-to-Video | 3.5s (25 frames @ 7fps) | 512x512 | <8GB |
141
+
142
+ - **Resolution options** — 512px, 576px, 720px, 1280px, 1920px (1080p), and custom dimensions (multiples of 8)
143
+ - **Quality tiers** — Fast (10 steps), Standard (30), High (40), Maximum (50)
144
+ - **Frame interpolation** — 1x raw, 2x doubled FPS, 2x + upscale for cinema-quality output
145
+ - **Prompt enhancement** — Cinematic, Realistic, Artistic, Anime, or raw
146
+ - **Low VRAM mode** — automatically reduces resolution, frames, and inference steps for 8–12GB GPUs
147
+ - **Batch processing** — queue multiple videos from a prompt list, processed by Celery workers
148
+ - **ComfyUI integration** — one-click launch to the node editor for custom workflows
149
+
150
+ ### GPU Image Upscaling — 4K and 8K Output
151
+
152
+ Upscale images and video frames to 4K (3840px) or 8K (7680px) resolution using GPU-accelerated super-resolution models.
153
+
154
+ | Model | Scale | Size | Best For |
155
+ |-------|-------|------|----------|
156
+ | HAT-L SRx4 | 4x | 159 MB | Maximum quality restoration |
157
+ | RealESRGAN x4plus | 4x | 64 MB | General-purpose, photorealistic |
158
+ | RealESRGAN x2plus | 2x | 64 MB | Mild upscaling |
159
+ | RealESRGAN x4plus (Anime) | 4x | 17 MB | Anime and stylized content |
160
+ | realesr-animevideov3 | 4x | 6 MB | Video-optimized anime |
161
+ | 4x-UltraSharp | 4x | 67 MB | Enhanced sharpness |
162
+ | 4x NMKD-Superscale | 4x | 67 MB | Advanced super-scaling |
163
+ | 4x Foolhardy Remacri | 4x | 67 MB | Texture-focused upscaling |
164
+
165
+ - **Two-pass mode** — run the model twice for maximum quality
166
+ - **Precision control** — FP16 (standard GPUs), BF16 (Ampere+), torch.compile for up to 3x speedup
167
+ - **Video upscaling** — frame-by-frame processing with progress tracking for MP4, MKV, AVI, MOV, WebM
168
+ - **Watch folder** — optional auto-processing of new files dropped into a directory
169
+
170
+ ### RAG That Actually Works
171
+
172
+ Chat grounded in your documents. Upload files, build a knowledge base, and ask questions. The AI reads and understands your content — not just keyword matching.
173
+
174
+ | Chat with Agent Screen | Agent YouTube Search |
175
+ |:-:|:-:|
176
+ | ![Chat](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/chat-agent-youtube-search.png) | ![Agent YouTube](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/chat-agent-youtube-search-wide.png) |
177
+
178
+ - **Hybrid retrieval** — BM25 keyword + vector semantic search combined
179
+ - **Smart chunking** — code files get AST-informed chunking, prose gets semantic splitting
180
+ - **Multiple embedding models** — switch between lightweight (300M) and high-quality (4B+) via UI
181
+ - **RAG Autoresearch** — autonomous optimization loop that experiments with parameters, keeps improvements, reverts regressions
182
+ - **Entity extraction** — automatic entity and relationship indexing
183
+ - **Per-project isolation** — each project has its own knowledge base and chat context
184
+
185
+ ### Self-Improving AI
186
+
187
+ The system runs its own test suite, identifies failures, dispatches an AI agent to read the code and fix the bugs, verifies the fix, and broadcasts the learning to other instances. No human in the loop.
188
+
189
+ - **Three modes** — Scheduled (every 6 hours), Reactive (triggered by repeated 500 errors), Directed (manual tasks)
190
+ - **Guardian review** — Uncle Claude (Anthropic API) reviews code changes for safety before applying, with risk levels and halt directives
191
+ - **Verification loop** — re-runs tests after every fix to confirm it worked
192
+ - **Pending fixes queue** — stage, review, approve, or reject proposed changes
193
+ - **Cross-machine learning** — fixes propagate to all connected instances via the Interconnector
194
+
195
+ ---
196
+
197
+ ## Full Feature Set
198
+
199
+ ### AI & Chat
200
+ - **60+ registered tools** across 13 categories — web search, direct URL fetch, browser automation, code execution, file management, media control, desktop automation, MCP integration, knowledge base, image generation, agent control, memory management
201
+ - **`fetch_url` primitive** — single-purpose URL fetcher separate from `web_search`, so the model picks the right tool on the first try when you name a specific domain
202
+ - **9 specialized agents** — code assistant, content creator, research agent, browser automation, vision control, and more
203
+ - **ReACT agent loop** — iterative reasoning, action, observation with tool execution guard and circuit breaker
204
+ - **Streaming responses** via Socket.IO with conversational fast-path (~700ms)
205
+ - **Tool call transparency** — collapsible tool call cards showing parameters, results, timing, and success/error status inline in chat
206
+ - Runtime model switching — swap LLMs through the UI, GPU memory managed automatically
207
+ - Voice interface — Whisper.cpp STT + Piper TTS with narration and voiceover
208
+ - Session history with search, grouping, previews, and persistent tool call data
209
+ - **Persistent memory** — save facts, instructions, and context across sessions with automatic LLM injection
210
+ - **Uncle Claude escalation** — optional Anthropic API integration for problems that need a bigger model, with monthly token budgeting
211
+
212
+ ### Image Generation
213
+ - Stable Diffusion via Diffusers library — batch queue with auto-registration to file system
214
+ - Face restoration, anatomy enhancement, and detail controls
215
+ - Image library with thumbnail grid, lightbox preview, keyboard navigation, batch operations
216
+ - **Bates-numbered output** — generated files auto-registered with timestamped sequential naming
217
+
218
+ ### Agent & Code Tools
219
+ - **Monaco code editor** — built-in IDE with AI-powered explain, fix, and generate via right-click context menu
220
+ - **Self-demo system** — automated feature tour with screen recording and TTS narration
221
+ - **Media viewer** — inline document and media previews with thumbnail strip navigation
222
+
223
+ ### File & Document Management
224
+ - Desktop-style UI — draggable folder icons, resizable windows, right-click context menus
225
+ - Drag-and-drop upload preserving folder structures
226
+ - Folder properties linked to clients, projects, and websites
227
+
228
+ ### Multi-Machine Sync (Interconnector)
229
+ - Connect multiple instances into a family that shares code, learnings, and model configs
230
+ - Master/client architecture with approval workflows and pre-sync backups
231
+
232
+ ### Plugin System
233
+ - **Managed plugins** with health monitoring, port-based orphan cleanup, and auto-restore on restart
234
+ - Ollama, ComfyUI, Vision Pipeline, Upscaling, Swarm Orchestrator, and Discord bot
235
+ - Live VRAM monitoring with GPU conflict detection
236
+ - Model download management from HuggingFace with progress tracking
237
+
238
+ ### Vision Pipeline
239
+ - Real-time frame analysis via Ollama vision models with adaptive FPS throttling
240
+ - Two-layer change detection — perceptual hash + semantic analysis
241
+ - Local camera capture with device enumeration and stream management
242
+ - Context buffer with sliding window and compression
243
+
244
+ ### System
245
+ - Dashboard with live status cards for model health, GPU, self-improvement, RAG
246
+ - Celery background task system with live progress
247
+ - Six built-in themes
248
+ - Container support with Containerfile for isolated testing
249
+ - Comprehensive backup and restore — granular or full, with schema migration support
250
+
251
+ ---
252
+
253
+ ## Screenshots
254
+
255
+ | Dashboard | Code Editor |
256
+ |:-:|:-:|
257
+ | ![Dashboard](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/dashboard-page.png) | ![Code Editor](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/code-editor-page.png) |
258
+
259
+ | Media Library | Video Generation |
260
+ |:-:|:-:|
261
+ | ![Media](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/media-library-page.png) | ![Video Gen](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/video-generation-page.png) |
262
+
263
+ | Plugins | Swarm Plan Editor |
264
+ |:-:|:-:|
265
+ | ![Plugins](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/plugins-page.png) | ![Swarm](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/swarm-plan-editor.png) |
266
+
267
+ | Settings — RAG | Settings — Memory |
268
+ |:-:|:-:|
269
+ | ![Settings RAG](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/settings-page-rag.png) | ![Settings Memory](https://raw.githubusercontent.com/guaardvark/guaardvark/main/docs/screenshots/settings-page-memory.png) |
270
+
271
+ ---
272
+
273
+ ## Quick Start
274
+
275
+ ```bash
276
+ git clone https://github.com/guaardvark/guaardvark.git
277
+ cd guaardvark
278
+ ./start.sh
279
+ ```
280
+
281
+ First run handles everything: Python venv, Node dependencies, PostgreSQL, Redis, Ollama, Whisper.cpp, database migrations, frontend build, and all services. Requires your system password once for PostgreSQL setup.
282
+
283
+ | Service | URL |
284
+ |---------|-----|
285
+ | Web UI | http://localhost:5173 |
286
+ | API | http://localhost:5000 |
287
+ | Health Check | http://localhost:5000/api/health |
288
+
289
+ ```bash
290
+ ./start.sh # Full startup with health checks
291
+ ./start.sh --fast # Skip dependency checks
292
+ ./start.sh --test # Health diagnostics
293
+ ./start.sh --plugins # Start all enabled plugins
294
+ ./stop.sh # Stop all services
295
+ ```
296
+
297
+ ### Install via PyPI
298
+
299
+ ```bash
300
+ pip install guaardvark
301
+ ```
302
+
303
+ The CLI connects to a running Guaardvark instance or launches a lightweight embedded server automatically.
304
+
305
+ ---
306
+
307
+ ## CLI
308
+
309
+ 41 commands with tab completion and fuzzy matching. Install from PyPI or use the built-in REPL.
310
+
311
+ ```bash
312
+ guaardvark # Interactive REPL
313
+ guaardvark status # System dashboard
314
+ guaardvark chat "explain this codebase" # Chat with RAG context
315
+ guaardvark search "query" # Semantic search
316
+ guaardvark files upload report.pdf # Upload and index
317
+ ```
318
+
319
+ ### REPL Slash Commands
320
+
321
+ ```
322
+ /imagine <prompt> Generate an image from text
323
+ /video <prompt> Generate a video from text
324
+ /voice <text> Text-to-speech output
325
+ /agent Toggle autonomous agent mode
326
+ /web Open the web UI
327
+ /ingest <path> Index files or directories for RAG
328
+ /search <query> Semantic search over indexed documents
329
+ /models list List available Ollama models
330
+ /remember <text> Save to persistent memory
331
+ /memory list|search Browse saved memories
332
+ /backup create Create a system backup
333
+ /jobs list|watch Monitor background tasks
334
+ /config View or change settings
335
+ /help Full command reference
336
+ ```
337
+
338
+ ---
339
+
340
+ ## Requirements
341
+
342
+ | Dependency | Version | Notes |
343
+ |-----------|---------|-------|
344
+ | Python | 3.12+ | Backend |
345
+ | Node.js | 20+ | Frontend build |
346
+ | PostgreSQL | 14+ | Auto-installed |
347
+ | Redis | 5.0+ | Auto-installed |
348
+ | Ollama | latest | Local LLM inference |
349
+ | CUDA GPU | 8GB+ VRAM | 16GB recommended for video generation |
350
+
351
+ ### GPU Memory Guide
352
+
353
+ | Feature | Minimum | Recommended |
354
+ |---------|---------|-------------|
355
+ | Chat + RAG | 4GB | 8GB |
356
+ | Image generation | 6GB | 12GB |
357
+ | Wan 2.2 video | 11GB | 16GB |
358
+ | CogVideoX-5B video | 16GB | 20GB |
359
+ | Upscaling | 0.5GB | 2–4GB |
360
+
361
+ ---
362
+
363
+ ## Architecture
364
+
365
+ ```
366
+ Browser / CLI (PyPI: guaardvark)
367
+ | HTTP + WebSocket
368
+ v
369
+ Flask (68 REST blueprints + GraphQL + Socket.IO)
370
+ |
371
+ +-- AgentBrain (3-tier routing: Reflex → Instinct → Deliberation)
372
+ |
373
+ Service Layer (48 modules)
374
+ |-- Agent Executor (ReACT loop + 57 tools + BrainState)
375
+ |-- RAG Pipeline (LlamaIndex + hybrid retrieval)
376
+ |-- Self-Improvement Engine (detect → fix → verify → broadcast)
377
+ |-- Generation Services (image, video, voice, content)
378
+ |-- Swarm Orchestrator (parallel agents + git worktree isolation)
379
+ |-- Servo Controller (closed-loop vision targeting + calibration)
380
+ |-- Vision Pipeline (frame analysis + camera capture)
381
+ \-- Interconnector (multi-machine sync)
382
+ |
383
+ +---+---+---+---+
384
+ v v v v v
385
+ PostgreSQL Redis Ollama Virtual Display ComfyUI
386
+ Celery (Xvfb :99)
387
+ ```
388
+
389
+ **Frontend:** React 18 · Vite · Material-UI v5 · Zustand · Apollo Client · Monaco Editor · Socket.IO
390
+ **Models:** Gemma4 · Qwen3-VL · Qwen3 · Llama 3 · Moondream · Stable Diffusion · Wan 2.2 · CogVideoX · Real-ESRGAN · HAT
391
+
392
+ ---
393
+
394
+ ## Support the Project
395
+
396
+ Guaardvark is built with love by a solo developer. If it's useful to you:
397
+
398
+ - [Ko-fi](https://ko-fi.com/albenze) (zero fees!)
399
+ - [GitHub Sponsors](https://github.com/sponsors/guaardvark)
400
+ - [PayPal](https://paypal.me/albenze)
401
+
402
+ Star the repo if you find it interesting — it helps with visibility.
403
+
404
+ ---
405
+
406
+ ## Contributing
407
+
408
+ We welcome contributions! See the [Contributing Guide](CONTRIBUTING.md) to get started.
409
+
410
+ Looking for something to work on? Check out issues labeled [`good first issue`](https://github.com/guaardvark/guaardvark/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
411
+
412
+ ---
413
+
414
+ ## License
415
+
416
+ [MIT License](LICENSE) — Copyright (c) 2025-2026 Albenze, Inc.