Skip to main content
A vault is a named reference to a directory of Markdown files on your filesystem. smolbren stores the vault’s search index and knowledge graph separately in its data directory (~/.smolbren/vaults/<name>/), so your source files are never modified. All commands that operate on notes (search, query, get, links, etc.) require at least one vault to be registered and indexed.

vault add

Register a new vault by giving it a name and pointing it at a directory. Synopsis
string
required
A short, memorable name for this vault. Used with --vault to select it in other commands. Must be unique across all registered vaults.
path
required
Absolute or relative path to the root directory of your Markdown vault. The path is canonicalized to an absolute path at registration time; the directory must already exist.
boolean
Mark this vault as the default. When --default is set, subsequent commands that need a vault will use this one automatically without requiring --vault. The first vault you add is always made the default regardless of this flag.
Example
The path in the response is the canonicalized absolute path. The default field reflects whether this vault is now the active default.

vault list

List all registered vaults and their current status. Synopsis
Output Returns an array of vault objects. Each object contains: Example

vault remove

Unregister a vault by name. Synopsis
string
required
The name of the vault to remove, as it appears in vault list.
vault remove permanently deletes the vault’s index data from ~/.smolbren/vaults/<name>/, including the notes dataset, edges dataset, and ontology cache. Your source Markdown files are untouched, but you will need to run smolbren index again if you re-add the vault. This operation cannot be undone.
If the removed vault was the default, no default vault is set afterward — you must either add a new vault with --default or update your config manually. Example