# SwarmVault — Local-First LLM Wiki + Graph

> SwarmVault turns docs/code/transcripts into a durable Markdown wiki plus a local knowledge graph for agents, with a 30-second `quickstart` CLI path.

## Install

Copy the content below into your project:

## Quick Use

1. Install + quickstart:
   ```bash
   npm install -g @swarmvaultai/cli
   swarmvault quickstart ./your-repo
   ```
2. Next commands:
   ```bash
   swarmvault next
   swarmvault query "What are the key concepts?"
   swarmvault graph serve
   ```

## Intro

SwarmVault turns docs/code/transcripts into a durable Markdown wiki plus a local knowledge graph for agents, with a 30-second `quickstart` CLI path.

- **Best for:** teams building long-lived knowledge bases for agents (wiki + graph + reviewable artifacts)
- **Works with:** Node.js (README badge says >=24); local-first outputs under raw/wiki/state; optional model providers
- **Setup time:** 10–30 minutes

## Practical Notes

- Quant: README says **Try It in 30 Seconds** with `swarmvault quickstart` after install.
- Quant: the on-disk layout includes `raw/`, `wiki/`, and `state/graph.json` (a machine-readable graph).

## Main

A compounding workflow:

1. Use `quickstart` for the first run, then switch to explicit `ingest` → `compile` → `query` once you trust the outputs.
2. Keep “raw sources” immutable; treat `wiki/` as the compounding artifact you review and edit.
3. Use `compile --approve`/review bundles when you need stricter change control.

SwarmVault is most valuable when you commit (or at least archive) the generated wiki so future agents inherit the same context.

### FAQ

**Q: Do I need API keys to start?**
A: No—README says the first run can use a built-in local heuristic provider.

**Q: What files does it create?**
A: A vault with `raw/`, `wiki/`, and `state/` including `state/graph.json`.

**Q: How do I share context with agents?**
A: Export or point agents at the generated `wiki/` and graph artifacts, not raw transcripts.

## Source & Thanks

> Source: https://github.com/swarmclawai/swarmvault
> License: MIT
> GitHub stars: 442 · forks: 49

---

<!-- ZH -->

## 快速使用

1. 安装并快速开始：
   ```bash
   npm install -g @swarmvaultai/cli
   swarmvault quickstart ./your-repo
   ```
2. 常用后续命令：
   ```bash
   swarmvault next
   swarmvault query "关键概念是什么？"
   swarmvault graph serve
   ```

## 简介

SwarmVault 把文档/代码/转写记录转成可持续累积的 Markdown wiki 与本地知识图谱，并提供 30 秒 `quickstart` 的 CLI 路径，适合为 agent 构建可复用上下文资产。

- **适合谁：** 想为 agent 建长期知识库（wiki + 图谱 + 可复核产物）的团队
- **可搭配：** Node.js（README 标注 >=24）；本地产物写入 raw/wiki/state；可选外部模型提供方
- **准备时间：** 10–30 分钟

## 实战建议

- 量化信息：README 写明 **30 秒上手**：安装后运行 `swarmvault quickstart`。
- 量化信息：落盘结构包含 `raw/`、`wiki/` 与 `state/graph.json`（机器可读图谱）。

## 主要内容

让知识“复利”的用法：

1. 第一次用 `quickstart` 跑通流程；建立信任后用 `ingest` → `compile` → `query` 显式控制每一步。
2. 保持 raw sources 不可变；把 `wiki/` 当作长期累积资产，按需 review 与编辑。
3. 需要更严格控制时使用 `compile --approve` 之类的审核束。

SwarmVault 的价值来自“可继承”：把生成的 wiki 提交或归档，后续 agent 才能复用同一份上下文。

### FAQ

**起步需要 API key 吗？**
答：不需要；README 表示首跑可用内置 heuristic provider 本地离线运行。

**会生成哪些文件？**
答：创建包含 `raw/`、`wiki/`、`state/` 的 vault，并生成 `state/graph.json`。

**怎么给 agent 提供上下文？**
答：优先给 agent `wiki/` 与图谱产物，而不是堆叠原始转写/聊天记录。

## 来源与感谢

> Source: https://github.com/swarmclawai/swarmvault
> License: MIT
> GitHub stars: 442 · forks: 49


---
Source: https://tokrepo.com/en/workflows/swarmvault-local-first-llm-wiki-graph
Author: AI Open Source