Skip to content
virvir docs

Obsidian plugin

vir-obsidian is a separate, open-source plugin. The CLI works without it; the plugin makes the vault feel native.

What it does

Section titled “What it does”
  • Status bar — a health dot for the daemon: healthy, stale, down, or CLI not found. Click it to open settings.
  • Recent tab — every vir-distilled note in the vault, newest first, color-coded by category: patterns, gotchas, decisions, tools, articles, PDFs, topic pages.
  • Related tab — runs vir query against the note you’re editing and surfaces what’s relevant, so the right note finds you while you’re writing.
  • Search — a command palette entry for vir query with results as clickable notes.
  • Low-confidence notes render dimmer.

Install

Section titled “Install”

The plugin shells out to the vir binary, so install the CLI first.

  1. Obsidian → Settings → Community plugins → Browse → search Vir (plugin id vir). Or install manually from the releases page.
  2. Enable it. If the status dot says CLI not found, set the binary path in the plugin settings (which vir prints it).

Desktop only — the plugin needs a shell, which Obsidian mobile doesn’t provide.

How it talks to vir

Section titled “How it talks to vir”

Three stable JSON contracts: vir query --json for results, vir doctor --json for health and vir review --json for the review queue and its approve, reject and restore actions (Review needs vir 0.23.0 or newer). All are versioned with the CLI; a CLI upgrade never breaks a plugin render without a matching plugin release.