vault-doctor

Generate a read-only drift report comparing Obsidian index files and AGENTS contracts to the filesystem.

Updated Nov 23, 2016
One-click install
npx skills add https://github.com/jshreynolds/localetc --skill vault-doctor-jshreynolds
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vault-doctor
Source: https://github.com/jshreynolds/localetc/tree/main/ai/skills/vault-doctor
Command: npx skills add https://github.com/jshreynolds/localetc --skill vault-doctor-jshreynolds

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill identifies inconsistencies and issues within an Obsidian vault, such as missing files, unresolved links, and missing frontmatter, to ensure the vault is in a consistent and usable state.

Core Features & Use Cases

  • Drift Report: Generates a report comparing Obsidian's index files and AGENTS contracts to the actual filesystem contents, highlighting any discrepancies.
  • Read-Only: The skill does not modify the vault, ensuring safety and integrity.
  • Use Case: Before organizing or cleaning up an Obsidian vault, run this skill to identify potential issues that may need attention.

Quick Start

Use the vault-doctor skill to check the consistency of your Obsidian vault by running vault-doctor from the root directory of your vault.

Frequently Asked Questions about vault-doctor

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check my Obsidian vault for missing files and unresolved links?

To check an Obsidian vault for missing files and unresolved links, generate a read-only drift report comparing index files and AGENTS contracts to the actual filesystem. This identifies discrepancies without modifying vault contents.

What is an Obsidian vault health check and how does a drift report work?

An Obsidian vault health check is a consistency audit that generates a drift report. It compares Obsidian's index files and AGENTS contracts to the actual filesystem to highlight missing files, unresolved links, and frontmatter issues.

Can I run a consistency check on my Obsidian vault without modifying the contents?

You can run a read-only consistency check on an Obsidian vault without modifying contents. The vault-doctor skill generates a drift report identifying missing files and frontmatter issues while ensuring vault safety and integrity.

How do I identify missing frontmatter and broken links before organizing my Obsidian vault?

To identify missing frontmatter and broken links before organizing an Obsidian vault, run a vault health check from the root directory. This produces a drift report highlighting unresolved links and frontmatter discrepancies for pre-vault maintenance.

Does the vault health check compare AGENTS contracts to the actual filesystem?

The vault health check does compare AGENTS contracts to the actual filesystem. It generates a read-only drift report that highlights discrepancies between the defined contracts, index files, and the current vault contents.

What are the limitations of running a read-only consistency check on an Obsidian vault?

A read-only consistency check on an Obsidian vault identifies missing files, unresolved links, and frontmatter issues but does not modify or fix the vault contents. Users must manually resolve the discrepancies highlighted in the drift report.