Skip to content

Tejaaswini/obsidian-plugin

Repository files navigation

Vault Physician

AI-powered vault health and maintenance engine for Obsidian.

Vault Physician continuously monitors your knowledge base for structural problems - orphaned notes, stale content, tag sprawl, frontmatter inconsistencies, etc and surfaces them in a clean dashboard with one-click fixes. Optionally connect an LLM to get a plain-English diagnosis of your vault's biggest problems.


Features

Core Diagnostics (always on)

Module What it finds
Orphan Detector Notes with zero backlinks that haven't been touched in a while
Decay Scanner Notes not modified in 180+ days
Frontmatter Linter Missing common keys and type mismatches across your vault
Tag Hygiene Near-duplicate tags (e.g. #ml vs #ML), single-use tags, tag sprawl

Semantic Features (optional)

Module What it finds
Link Suggester Related notes that aren't linked yet - with a confirm dialog to pick which links to add
Duplicate Finder Notes that are suspiciously similar in content

AI Analysis (optional)

Connect OpenAI, Anthropic, or a local Ollama model to generate a plain-English narrative after each scan and identifies patterns across your vault and tells you the single most impactful thing to fix first.

Dashboard

  • SVG ring health gauge - 0–100 score with color (green / yellow / red)
  • Severity filter pills - show only critical, warning, or info issues
  • Collapsible module sections with issue counts
  • Fix-all button per module - runs all auto-fixes in one click
  • Weekly digest - generates a Markdown note summarising vault health

Screenshots

Dashboard AI Analysis
Tags and fixes AI Analyser
Settings AI Settings
Settings Enable AI setting

Installation

Manual (until listed in Community Plugins)

  1. Download main.js, manifest.json, and styles.css from the latest release
  2. Copy them to <your-vault>/.obsidian/plugins/vault-physician/
  3. In Obsidian: Settings → Community Plugins → disable Restricted Mode → refresh → enable Vault Physician

Setup

Semantic features (link suggestions + duplicate detection)

  1. Settings → Vault Physician → Enable semantic features - toggle on
  2. Run a scan - the search index builds automatically in the background

No API key required. Uses BM25 keyword similarity via MiniSearch.

AI Analysis

  1. Settings → Vault Physician → AI Analysis → Enable AI analysis - toggle on
  2. Pick a provider:
    • OpenAI - gpt-4o-mini is recommended. Get a key at platform.openai.com
    • Anthropic - claude-haiku-4-5-20251001. Get a key at console.anthropic.com
    • Ollama (local, free) - brew install ollama && ollama pull llama3.2
  3. Run a scan — the AI Analysis card appears in the dashboard

Usage

  • Status bar - the 🏥 NN item shows your current health score. Click it to open the dashboard
  • Ribbon icon - stethoscope icon opens the dashboard
  • Commands (Cmd+P):
    • Vault Physician: Run full vault scan
    • Vault Physician: Open dashboard
    • Vault Physician: Generate weekly digest
    • Vault Physician: Rebuild search index

Roadmap

  • v0.3.0 — LLM-powered fix suggestions (not just diagnosis)
  • v0.4.0 — Broken link detection and repair
  • v0.5.0 — Community Plugins submission

Development

git clone https://github.com/your-username/vault-physician
cd vault-physician
npm install
npm run dev        # watch mode
npm run build      # production build

Copy main.js, manifest.json, styles.css to your vault's plugin folder to test.


License

MIT

About

AI-powered vault health monitor for Obsidian : finds orphaned notes, stale content, tag sprawl, and broken structure with one-click fixes.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors