Skip to content

mmoe316/vault_doctor

Repository files navigation

Vault Doctor 🩺

Fix your slow, crashing, or bloated Obsidian Vault.

The Problem

Obsidian vaults grow over time. Large images, broken links, and orphaned attachments can slow down your experience or even crash the mobile app.

The Solution

Vault Doctor is a free, open-source CLI tool that:

  • 🧹 Identifies orphaned files (files not linked in any note)
  • 🔗 Finds broken links
  • 📊 Reports on large files wasting space

Quick Start (CLI)

  1. Download the latest binary from Releases.
  2. Run it inside your Obsidian Vault:
    ./vault_doctor
  3. Read the generated report 00_Vault_Health_Report.md.

Development

Prerequisites

  • Gleam
  • Node.js (for the website)

Running the CLI

gleam build --target javascript
node run_cli.js

Running the Website

The website is a static Lustre application.

python3 -m http.server
# Open http://localhost:8000

Support

This tool is free. If it saved your vault, consider buying me a coffee.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published