QMD

Local semantic search for Obsidian.

QMD bridges Obsidian with a local QMD daemon to deliver fast, privacy-first semantic search across your vault. All processing happens on your machine—no data leaves your device. Search by meaning instead of keywords, discover related notes automatically, and keep your notes indexed in real time.

This repo keeps plugin implementation local; shared family assets are limited to contracts, docs, and harness/tooling skeletons.

Features

• Local semantic search — all processing runs on your machine; zero cloud dependencies
• Related notes view — always-on sidebar showing semantically similar notes
• Natural language search — find notes by meaning using the search modal
• Four search modes — keyword (BM25), semantic (vector), hybrid (combined), and advanced queries
• Auto-sync — automatically re-indexes notes when they change
• Fast response — instant results via local QMD daemon
• Privacy-first — zero data leaves your machine
• Snippet highlighting — search results include context snippets
• Wikilink insert — add results directly to your active note
• Status bar — real-time sync and indexing progress

Requirements

• Obsidian (desktop only; v0.15.0+)
• QMD daemon — local binary installed and running on your system
  • Installation: https://github.com/tobi/qmd
  • The plugin auto-detects the QMD binary on PATH or configure a custom path in settings
• Active QMD collection — a QMD collection matching your vault directory

Installation

From Release (Recommended)

1. Download main.js, manifest.json, and styles.css from the latest release
2. Create .obsidian/plugins/qmd/ in your vault
3. Copy the three files into that directory
4. Reload Obsidian
5. Enable QMD in Settings > Community plugins

From Source

cd <your-vault>/.obsidian/plugins
git clone https://github.com/GoBeromsu/obsidian-qmd.git qmd
cd qmd
pnpm install
pnpm build

Reload Obsidian and enable the plugin under Settings > Community plugins.

Usage

Getting Started

1. Ensure the qmd daemon is installed and available on your system
2. Create a QMD collection pointing to your vault folder
3. Configure the plugin in Settings > QMD
4. Open the search modal: use the command palette or your configured hotkey

Search Modes

QMD offers four complementary search modes:

Commands

• QMD: Open search — Open the search modal (primary interface)
• QMD: Open related notes — Show related notes for the active file
• QMD: Refresh related notes — Manually refresh the related notes view
• QMD: Sync qmd now — Trigger immediate indexing and embedding
• QMD: Run qmd update — Index new and changed files
• QMD: Run qmd embed — Generate embeddings for unindexed documents
• QMD: Re-scan qmd collections — Auto-detect QMD collections for this vault

Configuration

Open Settings > QMD to customize behavior.

Screenshots

Support

If you find QMD useful, consider supporting the developer:

Buy me a coffee

Development

pnpm install
pnpm dev           # vault selection + esbuild watch + hot reload
pnpm build         # TypeScript check + production build
pnpm test          # Unit tests (Vitest)
pnpm lint          # ESLint
pnpm run ci        # build + lint + test

Tech Stack

Project Structure

obsidian-qmd/
├── src/
│   ├── main.ts              # Plugin entry point
│   ├── domain/             # Auto-sync orchestration, settings, path resolution
│   ├── ui/                 # Search modal, related view, settings, notices, process adapter
│   ├── types/              # TypeScript type definitions
│   └── utils/              # Pure parsing and query helpers
├── scripts/                 # Build and release scripts
├── boiler.config.mjs        # Repo-specific harness/release configuration
└── manifest.json            # Obsidian plugin manifest

Contributing

1. Fork this repository
2. Create a feature branch (git checkout -b feature/your-feature)
3. Follow Conventional Commits
4. Run pnpm run ci to verify changes
5. Submit a pull request

License

MIT

Links

• GitHub Repository
• QMD Project
• Obsidian Plugin Docs