QMD Search

Local QMD search, related notes, and autosync for your vault.

Features

• Search by keyword (BM25), meaning (vector), hybrid, or advanced queries in a modal, with highlighted snippets.
• Related notes sidebar for the active note.
• Insert a result as a wikilink into the current note.
• Auto-sync re-indexes notes when they change, with progress in the status bar.

Usage

1. Install the QMD CLI and create a QMD collection that points at your vault folder.
2. Open Settings, QMD. The plugin finds the qmd binary on your PATH, or you can set its path.
3. Run Open search, type a query, and pick a mode.
4. Run Open related notes to see notes similar to the active one.

Other commands: Sync now, Run update, Run embed, Refresh related notes, Re-scan collections.

Installation

Desktop only, Obsidian 1.13.0 or later.

Community plugins: open Settings, Community plugins, Browse, search for "QMD", then Install and Enable.

Manual: download main.js, manifest.json and styles.css from the latest release into <vault>/<configDir>/plugins/qmd/, then enable the plugin. <configDir> is your vault's configuration folder (.obsidian by default).

Disclosures

• Network use: none from the plugin. It runs the local qmd command-line program on your machine; your notes are indexed and searched locally.
• Files outside the vault: the qmd program keeps its own index outside the vault, as set by its own configuration.
• Local programs and files: desktop only. The plugin runs the local qmd program with Node's child_process (it asks your login shell for command -v qmd when no path is set) and never reads the filesystem directly.
• Vault access: never lists the whole vault. To map a qmd result (a slugified path) back to a note, it looks only at the folders on that result's path. It edits a note only when you insert a result link into it.
• Clipboard: none. To use a result link, choose "Insert link" (right-click a result, or Shift+Enter in search), or drag the result into a note.
• Telemetry: none.

Development

See the dev contract: bun run dev, bun run build, bun run ci.

License

MIT