1.4 KiB
1.4 KiB
Quickstart Example
Use this when the user needs the shortest path from install to a working vault.
Commands
npm install -g @swarmvaultai/cli
swarmvault demo --no-serve
swarmvault init --obsidian
swarmvault scan ./repo --no-serve
swarmvault source add https://github.com/karpathy/micrograd
swarmvault diff
swarmvault graph blast ./src/index.ts
swarmvault query "What are the key concepts?"
swarmvault graph serve
swarmvault graph export --report ./graph-report.html
What To Check
swarmvault.schema.mdexists and reflects the vault contractdemo --no-serveleaves a temporary compiled vault behind even on a clean machinescan --no-serveleaves a compiled vault behind even when the viewer is not launchedstate/sources.jsoncontains the managed source registry entrywiki/graph/report.mdexists after compilegraph export --reportwrites a shareable HTML report when the user wants a lighter artifact than the full workspacewiki/outputs/source-briefs/contains a source briefwiki/outputs/contains the saved query answerstate/graph.jsonandstate/search.sqliteexist
Guidance
- If the answer quality is weak, check whether the vault is still on the
heuristicprovider. - If the user is unsure what changed, point them at
wiki/andstate/before suggesting another compile. - When the vault lives in git,
swarmvault diffis the quickest graph-level summary of what the last compile changed.