- Time: about 15 minutes
- You’ll need: a vouch KB with at least one approved page or claim (the first tutorial gets you there). Obsidian itself is optional — any markdown editor works; Obsidian just renders the wikilinks and graph.
Every command in this tutorial was run end-to-end against the current build
before it went into the docs.
- backward (KB → vault): approved pages and claims mirror out into the vault as readable, linked markdown.
- forward (vault → KB): edits you make in the vault come back as
page-edit proposals in
proposed/, which still have to clear the review gate.
1. Mirror the KB into a vault
Pick a folder for the vault and mirror approved artifacts into it:<vault>/vouch/:
claims/ with Obsidian wikilink backlinks to the pages that cite them —
so when you open the vault in Obsidian, the graph view connects claims to the
pages they support.
2. Open it in Obsidian
Point Obsidian at~/my-vault (Open folder as vault). Browse vouch/pages/,
open the graph view, and you’ll see the reviewed knowledge as a navigable web of
linked notes. This is a read-friendly window onto the same .vouch/ you’ve been
driving from the CLI — nothing here is a second copy of the truth, it’s a
projection of it.
3. Edit a page — the change becomes a proposal
Edit a mirrored page in Obsidian (or any editor). Add a line to a page under<vault>/vouch/pages/:
vault:<relpath> source pointing at the file you changed,
so the reviewer can see exactly which bytes triggered it — the gate isn’t
reviewing a vague “something changed,” it’s reviewing your specific edit.
4. Review the edit — the gate, as always
The proposal sits in the queue under thevault-sync actor until a human
accepts it. Because the proposer is vault-sync and not you, your approval
satisfies the gate:
5. Keep them in sync continuously
Run both directions at once, and add--watch to keep a polling loop alive
while you work in Obsidian:
Troubleshooting
| Symptom | Cause | Fix |
|---|---|---|
Missing option '--vault' | sync needs an explicit vault path. | Pass --vault <dir>. |
| Edited a vault file, no proposal | Ran backward, not forward. | vouch sync --vault <dir> --direction forward. |
| Edit went straight in with no review | You edited .vouch/ directly, not the vault. | Edit under <vault>/vouch/; the KB files are the reviewed output, not the input. |
| Vault page reverted after approve | A backward sync re-mirrored the canonical version. | Working as intended — the approved KB is the source of truth. |
Next steps
- Share a knowledge base across machines and teammates — move the reviewed KB beyond one machine.
- The object model — pages vs. claims, and how citations link them.
- The review gate in depth — every policy the gate enforces, including on vault-sourced proposals.