| title | How-To Guides |
|---|---|
| description | Task-oriented recipes for deploying, developing, operating, and extending VisionClaw — grouped into Core, Features, Integration, and Operations. |
VisionClaw Docs · How-To Guides
Practical, task-focused recipes. Each guide assumes VisionClaw is already running; if it is not, start with Installation and Deploy VisionClaw. For concepts and rationale see Explanation; for exhaustive lookups see Reference.
Day-to-day tasks for deploying, building, and driving the system.
| Guide | Task |
|---|---|
| Deploy VisionClaw | Launch the Docker stack with ./scripts/launch.sh, build natively with the GPU feature, install CUDA 13.1, and verify the service URLs. |
| Development Guide | Set up the Rust/React toolchain locally, navigate the project structure, run the test workflow, and add new features. |
| Agent Orchestration | Deploy, configure, and coordinate the multi-agent AI system via the Docker multi-container setup, MCP tools, and the Control Center's agent status surface. |
| REST API Usage | Integrate against the REST API — authentication, common workflows, error handling, pagination, and pairing with the WebSocket stream. |
| Performance Profiling | Identify and diagnose bottlenecks across GPU physics, WebSocket throughput, the render pipeline, and Oxigraph queries. |
| Quest 3 Setup | Side-load the Godot 4 + OpenXR XR APK onto a Meta Quest 3, enable developer mode, pair LiveKit voice, and verify multi-user presence. |
| Navigation Guide | Drive the 3D interface — camera movement, controls, and spatial navigation. |
| Use the Broker Inbox | Review and action governed proposals through the Judgment Broker Inbox. |
| ComfyUI SAM3D Setup | Stand up the ComfyUI SAM3D Docker service for 3D asset generation. |
How to use specific client and graph capabilities.
| Guide | Task |
|---|---|
| Auth & User Settings | Configure server-side authentication middleware and per-user settings lookup. |
| Command Palette | Use and extend the command palette — fuzzy search, keyboard navigation, and custom command registration. |
| Discovery & Similarity Search | Find semantically similar concepts, detect ontology gaps, and explore related nodes via content and structural analysis. |
| Filtering Nodes | Filter visible graph nodes by quality and authority scores held in node metadata. |
| Hierarchy Integration | Wire the class-hierarchy tree visualisation into the graph canvas. |
| Intelligent Pathfinding | Run semantic pathfinding that weights traversal by query relevance and graph semantics, not just hop count. |
| Local File Sync Strategy | Apply the two-pass parser, visibility classification, and Pod-first graph-commit saga. |
| System Health Monitoring | Use the HealthDashboard to track component health, physics status, and the MCP relay. |
| Natural Language Queries | Translate plain-English questions into graph queries via LLM-powered semantic understanding. |
| Nostr Authentication | Enforce NIP-07/NIP-98 browser-extension authentication before application access. |
| Onboarding | Start, skip, and restart the welcome tour, and understand how tour state persists. |
| Ontology Parser | Configure OWL 2 parsing and the Logseq Markdown conventions it reads. |
| Stress Majorisation | Configure and wire the stress-majorisation layout optimisation. |
| Voice Integration | Configure the STT/TTS voice pipeline. |
| Voice Routing | Route multi-user voice through the LiveKit SFU with push-to-talk and spatial audio for agents. |
| Workspace Management | Create, organise, and restore named graph configurations with the Workspace Manager. |
Connecting VisionClaw to external services and the Solid data plane.
| Guide | Task |
|---|---|
| ComfyUI Service Integration | Run ComfyUI as a supervised service on port 8188 with the API bridge. |
| Git over HTTP | Enable the git smart-HTTP backend on a Solid pod, then clone and push pod containers as git remotes with WAC authorisation and NIP-98 signed push. |
| Solid Pod Integration | Wire decentralised user data, graph views, ontology governance, agent memory, and Type Index discovery via JSS. |
| Solid Pod Creation | Provision and manage per-user Solid Pods. |
Running and maintaining VisionClaw in production. See the Operations index for the key metrics overview.
| Guide | Task |
|---|---|
| Configuration | Set environment variables, runtime settings, and YAML configuration. |
| Maintenance | Run routine maintenance, backups, and graph-store (Oxigraph) housekeeping. |
| Security | Apply authentication hardening, secrets management, and SSRF mitigations. |
| Telemetry & Logging | Set up structured logging, metrics, and observability. |
| Troubleshooting | Resolve common errors with diagnostic commands and known-issue notes. |
| Metrics Reference | Look up exposed counters, gauges, and histograms. |
| Pipeline Admin API | Manage the semantic intelligence pipeline lifecycle through admin REST endpoints. |
| Pipeline Operator Runbook | Follow the on-call playbook for monitoring, common issues, and recovery. |
| Power-User Pod Bootstrap | Bootstrap a power-user Solid Pod for advanced workflows. |
| Server Nostr Identity | Manage the server's Nostr identity and key operations. |
| Forum Runbook | Operate the nostr-rust-forum (nostr-bbs-rs) service. |
| agentbox Runbook | Operate the agentbox subsystem. |
| solid-pod-rs Runbook | Operate the solid-pod-rs Solid server. |
| Corpus Regeneration Scaling | Scale corpus regeneration (R3) under load. |
| Bridge Audit Drift | Detect and remediate bridge audit drift (R1). |
- Tutorials — start here if you are learning VisionClaw from scratch.
- Reference — exhaustive API, protocol, and configuration lookups.
- System Overview · Deployment Topology · Security Model — the concepts behind these tasks.
- Governing ADRs: ADR-080 — Forum-Kit Deployment Topology Patterns · ADR-011 — Auth Enforcement