swarmvault

name	swarmvault
description	Use SwarmVault when the user needs a local-first knowledge vault that writes durable markdown, graph, search, dashboard, review, context-pack, task-ledger, retrieval, and MCP artifacts to disk from books, notes, transcripts, exports, datasets, slide decks, files, URLs, code, and recurring source workflows.
version	3.5.0
metadata	{"openclaw":{"requires":{"anyBins":["swarmvault","vault"]},"install":[{"id":"node","kind":"node","package":"@swarmvaultai/cli","bins":["swarmvault","vault"],"label":"Install SwarmVault CLI (npm)"}],"emoji":"🗃️","homepage":"https://www.swarmvault.ai/docs"}}

SwarmVault

Use this skill when the user wants a local-first knowledge vault built on the LLM Wiki pattern — three layers (raw sources, wiki, schema) where the LLM maintains a durable wiki between you and raw sources. Also use it when the project already contains swarmvault.config.json or swarmvault.schema.md.

For onboarding, examples, command references, or troubleshooting, read the bundled README.md, examples/, references/, and TROUBLESHOOTING.md before improvising workflow advice.

Quick checks

• Work from the vault root.
• If the vault does not exist yet, run swarmvault init.
• Use swarmvault demo --no-serve when the user wants the fastest zero-config walkthrough before pointing SwarmVault at their own sources.
• Use swarmvault scan <directory> --no-serve when the user wants the fastest scratch pass over a local repo or docs tree without manually stepping through init + ingest + compile first; use swarmvault graph share --post for copyable text, swarmvault graph share --svg [path] for a visual card, or swarmvault graph share --bundle [dir] for a portable folder with markdown, post text, SVG, HTML preview, and JSON metadata.
• Use swarmvault context build "<goal>" --target <path-or-node> --budget <tokens> when the next agent, review, or handoff needs a bounded evidence pack instead of a broad vault search.
• Use swarmvault task start "<goal>" --target <path-or-node> when agent work should leave a durable task ledger with decisions, linked context packs, changed paths, outcomes, and follow-ups. The older memory command remains a compatibility alias.
• Use swarmvault doctor before broad troubleshooting or agent handoff; add --repair when the retrieval index can be safely rebuilt. In swarmvault graph serve, the workbench shows prioritized next actions, every doctor check with details, copyable suggested commands, and safe direct repair where available.
• Read swarmvault.schema.md before compile or query work. It is the vault's operating contract.
• If wiki/graph/report.md exists, use it before broad repo search.

Core loop

1. Initialize a vault with swarmvault init when needed.
2. Update swarmvault.schema.md before a serious compile. Use it for naming rules, categories, grounding, freshness expectations, and exclusions.
3. Use swarmvault source add <input> when the input is a recurring local file, local directory, public GitHub repo root, or docs hub that should stay registered.
4. Ingest one-off inputs with swarmvault ingest <path-or-url>, or ingest a whole repo tree with swarmvault ingest <directory>. Audio and video files use tasks.audioProvider when configured; local video needs ffmpeg, public video URLs use swarmvault ingest --video <url> / swarmvault add --video <url> with yt-dlp, and supported YouTube URLs go through direct transcript capture instead of generic URL ingest.
5. Use swarmvault ingest --guide, swarmvault source add --guide, swarmvault source reload --guide, swarmvault source guide <id>, or swarmvault source session <id> when the human should integrate one source at a time before canonical pages change. Set profile.guidedIngestDefault: true in swarmvault.config.json to make guided mode the default; use --no-guide to override. Profiles using guidedSessionMode: "canonical_review" stage approval-queued canonical edits; insights_only profiles keep exploratory synthesis in wiki/insights/. Use --review only for the lighter review-only path.
6. Use swarmvault inbox import for capture-style batches, then swarmvault watch --lint --repo when the workflow should stay automated. Add --code-only when the refresh should stay AST-only and defer non-code semantic re-analysis to a later compile. On tracked repos, code-only changes take that faster compile path automatically. Install swarmvault hook install when git checkouts and commits should trigger the same repo-aware code-only refresh automatically.
7. Compile with swarmvault compile, use compile --max-tokens <n> when the generated wiki must stay inside a bounded context budget, or use compile --approve when changes should go through the local review queue first.

Working rules

• Prefer changing the schema before re-running compile when organization or grounding is wrong.
• Treat wiki/ and state/ as first-class outputs. Inspect them instead of trusting a single chat answer.
• Prefer wiki/graph/report.md, state/graph.json, and saved wiki pages over ad hoc broad search when they already exist.
• Use source add for recurring files, directories, public GitHub repo roots, and docs hubs. Use ingest and add for deliberate one-off inputs.
• When the vault lives in a git repo, ingest|compile|query --commit can commit wiki/ and state/ changes immediately after the run.
• The default heuristic provider is a valid local/offline starting point. Add a model provider only when the user wants richer synthesis quality or optional capabilities such as embeddings, vision, image generation, or audio transcription. The recommended fully-local setup is Ollama + Gemma: ollama pull gemma4 then set providers.llm to { type: "ollama", model: "gemma4" } and point tasks.compileProvider, tasks.queryProvider, and tasks.lintProvider at it.
• Audio and video ingest need tasks.audioProvider to resolve to a provider that exposes audio capability. For a fully local setup, run swarmvault provider setup --local-whisper --apply — installs the local-whisper provider, downloads a whisper.cpp ggml model into ~/.swarmvault/models/, and points tasks.audioProvider at it. Local video also needs ffmpeg; public video URL ingest with --video needs yt-dlp. YouTube transcript ingest does not need a provider. Set graph.communityResolution when the user wants to pin community clustering instead of using the adaptive default, or run swarmvault graph cluster --resolution <n> for a one-off recompute.
• If an OpenAI-compatible backend cannot satisfy structured generation, reduce its declared capabilities instead of forcing every task through it.
• Keep raw sources immutable. Put corrections in schema, new sources, or saved outputs rather than manually rewriting generated provenance.

Files and artifacts

• swarmvault.schema.md: vault-specific compile and query rules.
• raw/sources/ and raw/assets/: canonical source storage.
• wiki/: generated pages plus saved outputs.
• wiki/outputs/source-briefs/: saved onboarding briefs for managed sources.
• wiki/outputs/source-sessions/: resumable guided-session anchors plus question/answer history for one-source-at-a-time integration.
• wiki/outputs/source-reviews/: staged source-scoped review pages.
• wiki/outputs/source-guides/: staged source-integration guides for one-source-at-a-time workflows.
• wiki/dashboards/: recent sources, reading log, timeline, source sessions, source guides, research map, contradiction, and open-question dashboards.
• wiki/graph/share-card.md, wiki/graph/share-card.svg, and wiki/graph/share-kit/: post-ready text, visual graph summaries, and a portable HTML-preview share bundle generated on compile.
• wiki/context/: markdown context-pack companions for agent kickoff, PR review, and handoff.
• wiki/memory/: task ledger index and markdown task pages.
• wiki/code/: module pages for ingested JavaScript, JSX, TypeScript (including .mts/.cts), TSX, Bash/shell script (with shebang-based detection for extensionless scripts), Python, Go, Rust, Java, Kotlin, Scala, Dart, Lua, Zig, C#, C, C++ (including .c/.cc/.cpp/.cxx and .h/.hh/.hpp/.hxx), PHP, Ruby, PowerShell (.ps1/.psm1/.psd1), Elixir (.ex/.exs), OCaml (.ml/.mli), Objective-C (.m/.mm), ReScript (.res/.resi), Solidity (.sol), Vue single-file components (.vue), HTML (.html/.htm), CSS, and SQL (.sql) sources. SQL adds table/view symbols plus read/write/join/reference graph edges.

Agent integration

• swarmvault install --agent codex|claude|cursor|goose|pi|gemini|opencode|aider|copilot|trae|claw|droid|kiro|hermes|antigravity|vscode|amp|augment|adal|bob|cline|codebuddy|command-code|continue|cortex|crush|deepagents|firebender|iflow|junie|kilo-code|kimi|kode|mcpjam|mistral-vibe|mux|neovate|openclaw|openhands|pochi|qoder|qwen-code|replit|roo-code|trae-cn|warp|windsurf|zencoder installs agent-specific rules into the current project. Agents in the extended roster receive a project-level skill bundle at the tool's conventional skills directory.
• swarmvault install --agent codex|claude|opencode|gemini|copilot --hook installs graph-first hook or plugin support for the agents that expose project hook APIs.
• swarmvault install --agent aider installs CONVENTIONS.md and wires .aider.conf.yml to read it when that config is valid YAML.
• swarmvault mcp exposes tools and resources for page search, page reads, source listing, graph stats, graph clustering refresh, community lookup, hyperedges, query, context-pack build/read/list, task start/update/finish/list/read/resume, compatibility memory tasks, vault doctor, retrieval status/rebuild/doctor, ingest, compile, and lint.

Defaults to preserve

• Keep raw source material immutable under raw/.
• Save useful answers unless the user explicitly wants ephemeral output.
• Prefer reviewable flows such as compile --approve, review, and candidate when a change should not activate silently.
• Treat provider setup as part of serious vault operation. If only heuristic is configured, say so clearly.
• When a vault uses the profile block in swarmvault.config.json, respect it as the deterministic behavior layer. swarmvault.schema.md still defines the human intent layer.