README file from
GithubVault Nexus
Finds context-related notes for the note you are writing, using your local Miyo index, and suggests links you accept or dismiss.
Nothing is ever written to a note without an explicit click.
Desktop only. Vault Nexus needs the Miyo desktop app running on the same computer, so it does not work on Obsidian mobile.
Requirements
- The Miyo desktop app, running on the same machine as Obsidian.
- Your vault must be one of the folders Miyo indexes (add it in Miyo under indexed folders).
That is the whole setup. No account, no token, no tunnel — the plugin talks to Miyo's local HTTP API on http://127.0.0.1:8742.
Installation
From the Community plugins directory
- In Obsidian, open Settings → Community plugins and turn off Restricted mode if needed.
- Select Browse, search for Vault Nexus, then select Install and Enable.
Manually (from a GitHub release)
- Download
main.js,manifest.jsonandstyles.cssfrom the latest release. - Create the folder
<your vault>/.obsidian/plugins/vault-nexus/and put the three files into it. - Restart Obsidian, then enable Vault Nexus under Settings → Community plugins.
With BRAT (beta testing)
Install the BRAT plugin and add the repository WAABoy/vault-nexus.
What it does
- Lists the notes Miyo considers related to the current note, with a matching excerpt and a relevance score.
- Lets you open a suggestion, insert a link to it, or dismiss it for a while.
- Skips the note itself, notes you already link to, ignored folders, and pairs you dismissed.
- Undoes the last link it added, restoring the note exactly as it was.
Usage
Open the panel from the ribbon icon or the command palette, then press Refresh. The list updates only when you ask it to — it never searches in the background.
Commands
| Command | What it does |
|---|---|
| Show related notes for the current note | Opens the panel and searches |
| Open the related notes panel | Opens the panel without searching |
| Test Miyo connection | Checks the backend and refreshes the folder mapping |
| Clear dismissed suggestions | Forgets every dismissal |
| Undo the last link that was added | Removes the most recently inserted link |
Where links go
Configurable under Linking:
- Under a "See also" heading (default) — reuses the heading if the note has one, creates it otherwise.
- At the end of the note.
- At the cursor — falls back to the end of the note if that note is not the one open in the editor.
The link itself is generated by Obsidian, so it follows your vault's own wikilink and shortest-path settings.
Settings
| Setting | Default | Notes |
|---|---|---|
| Local service URL | http://127.0.0.1:8742 |
Miyo's local API |
| Request timeout | 20 s | |
| Fallback to Miyo Relay | off | Optional; only used when the local service is unreachable |
| Result limit | 20 | Hits requested before filtering |
| Query length | 1200 | Characters of the note sent as the query |
| Restrict to this vault | on | Asks Miyo to search only folders inside this vault |
| Ignored folders | Templates |
Never suggested |
| Remember dismissals for | 30 days | Per source→target pair |
| Explain relations with a local LLM | off | Adds a per-result Why? button |
Privacy
By default, everything stays on your machine: the plugin only talks to Miyo on 127.0.0.1. There is no telemetry, no analytics and no account.
The plugin reads notes only inside your vault. It does not read or write files outside the vault.
Two features are opt-in and clearly marked, and both are off until you turn them on:
- Miyo Relay fallback sends your query to
relay.miyo.mdwhen the local service is unreachable. It needs a token, which is stored in this vault's plugin data folder in plain text. - Relation rationale sends two note titles and one excerpt to the OpenAI-compatible endpoint you configure (LM Studio on
127.0.0.1:1234by default).
The plugin is fully usable with both of them off.
Troubleshooting
"Miyo is not reachable" — the Miyo app is not running. Start it and press Retry.
No results, but Miyo has the notes — check that this vault is an indexed folder in Miyo, and that indexing has finished. Run Test Miyo connection to see the indexed file count.
Results point at the wrong notes — turn off Detect the Miyo folder automatically and set the folder prefix Miyo uses for this vault by hand.
Development
npm install
npm run dev # watch build
npm run build # typecheck + production bundle
Author
Made by Schattenbeutel (@WAABoy).
Vault Nexus is an independent community plugin. It is not affiliated with Obsidian or with Miyo.