Docs / Obsidian vault
Use ModelBrain with an Obsidian vault
An Obsidian vault is a folder of Markdown files, and ModelBrain reads folders of Markdown files. Add the vault folder once and any assistant you have connected can answer from your notes and tell you which note it used. There is no plugin to install, and Obsidian does not even need to be running.
1 · Add the vault
If ModelBrain is not set up yet, start with the quickstart. Then, on macOS or Windows, open the ModelBrain menu, choose Add Vault… and pick the folder your Obsidian vault lives in. In ModelBrain, a vault is just a folder you have added, so the word means the same thing in both apps.
From a terminal, the same thing is:
connector_sync sync obsidian ~/Documents/MyVault
The first word after sync is a short name you choose for the folder. Use it later to pause, resume or remove it. The full command set is in Add, remove and rescan folders.
2 · Give it a little time
The first pass reads every note and runs in the background, so a large vault can take a while before everything is searchable. After that, only notes that changed are read again. Sync is not instant: a saved note takes a little while to show up in answers. The table further down says what has been measured and what has not.
3 · Ask about your notes
In a connected assistant, ask the way you would ask a person who had read your vault. Here is an illustration of the kind of exchange to expect. The notes and the answer are made up for the example.
"What did I decide about the pricing page, and where did I write it down?"
…the assistant calls ModelBrain…
"You decided to keep the monthly price visible and drop the
comparison table. That is in Projects/Website/Pricing decisions.md."
Answers point back to the note they came from, so you can open it in Obsidian and check. If the answer is not in your notes, reasoning mode says so instead of guessing. See reasoning mode, explained for how that works.
What gets read, and what does not
Read
Your Markdown notes and any plain text, Word, PowerPoint and Excel files, PDFs with real text, HTML, and code or config files kept in the vault.
Skipped
Images, video and scanned PDFs. Obsidian's own .obsidian settings folder is skipped along with every other folder or file whose name starts with a dot.
Folders such as node_modules and files that look like secrets (.env, keys, anything named credentials) are excluded automatically too. The full list is on the folders page.
Edits, deletions and private notes
- Edit a note and the next sync replaces the old text with the new. ModelBrain does not keep earlier versions, so what your assistant sees is what the note says now.
- Delete a note and it is dropped from ModelBrain on a later sync, not the instant you delete it.
- Keep something private by leaving it out of the folder you add. If your vault holds a mix, add a subfolder instead of the whole vault, or keep the private notes in a separate vault.
- Stop at any time. Pause Syncing holds updates, Stop Syncing keeps what was already read searchable, and “Remove Vault and Forget Its Contents…” deletes it from ModelBrain for good. Your Obsidian files are never changed or removed by any of these.
What is tested
Each line below is backed by an automated test that runs against a sample vault. A line only says Tested when the whole behavior passes. Anything not fully checked says so.
Tested and working (27)
Plain Markdown notes are read and searchable
Tested
Dot-folders and dotfiles (.obsidian, .git, .trash, .DS_Store) and Word lock files are skipped
Tested
Frontmatter is read as note properties; title, aliases and tags are searchable; properties with secret-like names (token, password, api key and similar) are never stored
Tested
Odd frontmatter (broken YAML, byte order marks, Windows line endings, a horizontal rule in the body) never stops a note from being indexed
Tested
Inline #tags, nested tags and tag case are handled; hashes in code, links and headings are not tags
Checked by searching for the tag text. How high the real model ranks them is measured separately.
Tested
Wikilinks keep their visible text and target name in search; brackets and pipes are removed
Tested
Links resolve the way Obsidian resolves them: shortest path, same names in different folders, case, links without .md, Markdown-style links, aliases; links to missing notes are ignored
Tested
Embedded notes (![[Note]]) are searchable under the note that embeds them; image and PDF embeds are ignored
Tested
Callouts, tasks, footnotes, math, Mermaid and HTML comments keep their text
Tested
Text inside %%comments%% is never stored
Tested
Canvas files are searchable by their card text, without coordinates or ids
Tested
Dataview fields stay as plain text; Dataview and Templater code blocks and compressed Excalidraw data are left out
Template folders can be excluded when you add a vault.
Tested
Daily notes are found by their date and by their content
Tested
Notes are found by any of their aliases
Tested
PDF text is read; images and audio are skipped without errors
Tested
Renaming or moving a note leaves exactly one entry, at the new path
Tested
Editing a note while sync runs never produces text from two versions of the same note
Checked with a rewrite-while-syncing stress test.
Tested
Empty notes, notes over a megabyte and notes with 10,000 links sync without errors
Tested
Symlink loops end; links pointing outside the vault are not followed
Tested
Adding a subfolder indexes only that subfolder
Tested
Answers cite the note path relative to the vault, and it points at a real file
Tested
Removing a vault leaves no hits behind, and your vault files are never changed
Tested
Obsidian's Excluded files setting is honored
Tested
Long notes are split at headings, and a result carries its heading path
Tested
An assistant can walk the vault: a note's links and backlinks, up to 20 each
Tested
Search can be limited to a folder or to a tag
Tested
Results name the vault and the note title, not only a path
Tested
Partly verified (8)
Names with spaces, emoji, accents and case-only renames end up as one entry
Verified on Linux. Windows long paths and reserved names, and macOS and Windows case behavior, still need a run on those systems.
Partly verified
Large vaults: a 20,000-note vault completes its first pass in linear time
Engine timing recorded; memory use stayed low. Real-model speed and menu-bar responsiveness during the first pass are not measured yet.
Partly verified
Notes that iCloud has evicted to a placeholder keep their indexed text
iCloud placeholders are verified. Dropbox and OneDrive on-demand files have not been tested on a real synced folder.
Partly verified
Each vault can be placed in a partition, moved, renamed, archived and restored without losing notes
Works from the command line. The menu-bar Add Vault window does not offer a partition choice yet.
Partly verified
Instruction-like text planted in notes is flagged when stored
Flagging is tested in every place a note can hold text. Whether a model resists those instructions has not been re-measured on vault notes.
Partly verified
Results include an obsidian:// link that opens the note
The link is built and unit tested. Opening it has not been checked by hand on macOS and Windows yet.
Partly verified
A saved note becomes searchable within seconds
The sync engine is fast enough in tests (a 300-note vault, median 5.6 seconds before the latest speedup). The figure with the real model is not measured yet.
Partly verified
First pass speed is recorded for 5,000 and 20,000 notes
About 1,400 to 1,500 notes per second for the engine alone. Real-model speed depends on your computer and is measured separately.
Partly verified
Built, not measured yet (1)
A search for a note's title ranks that note first
Each note now carries its title for search. The ranking figure still needs a run with the real model.
Not measured yet
Built, off by default (1)
Backlinks can lift related notes in results
Built and tested, but off by default until it passes the recall benchmark guard.
Off by default
Where your notes go
For local use, nothing leaves your computer. ModelBrain reads the files where they sit, and the index lives on your machine. ChatGPT connects through a relay and needs a free account, covered in ModelBrain and ChatGPT. Sync between computers is a separate, optional feature that is not launched yet.
ModelBrain is an independent product from NexSpark and is not affiliated with or endorsed by Obsidian. Obsidian is a trademark of its owners.
Folder controls
Everything about adding, pausing, rescanning and removing a folder.
Read the guide →
Quickstart
Install, connect an assistant and test recall in five steps.
Read the guide →