Communitygithub.com

rogerdigital/vault-inspector

Ein Obsidian-Vault-Gesundheitschecker zum Auffinden von defekten Links, verwaisten Anhängen, Duplikaten, Frontmatter-Abweichungen, veralteten Tags und großen Dateien.

Was ist vault-inspector?

Vault Inspector ist ein schreibgeschütztes Qualitätstool für die Obsidian-Vault-Wartung, das in der CLI, in CI-Pipelines und in agentengesteuerten Workflows eingesetzt werden kann. Es identifiziert defekte Links, verwaiste Anhänge, leere Notizen, externe Links, doppelte Dateien, Frontmatter-Typ-Abweichungen, Probleme mit Tags und große Dateien. Das Tool unterstützt die Formate JSON und Markdown, ermöglicht die Auswahl einzelner Scanner und bietet einen Baseline-Vergleich, um nur neue Funde zu melden. Es wird als `npx vault-inspector` oder über die global installierte `vinspect`-CLI verwendet. Die Ausgabe priorisiert Fehler, Warnungen und Informationen und enthält stabile Felder für die Automatisierung, wobei `--fix` explizit nicht verfügbar ist – alle Funde müssen manuell überprüft werden.

Funktioniert mit~Claude Code~Codex CLI~Cursor
npx skills add rogerdigital/vault-inspector

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

Vault Inspector

Verwenden Sie Vault Inspector als schreibgeschütztes Qualitätstor für die Obsidian-Vault-Wartung. Der Skill ist für Terminal-, CI- und agentengesteuerte Vault-Workflows gedacht, die defekte Links, verwaiste Anhänge, leere Notizen, externe Links, doppelte Dateien, Frontmatter-Typ-Abweichungen, Probleme mit Tags und große Dateien finden müssen.

Sicherheitsregeln

  • Behandeln Sie die CLI als schreibgeschützt. Ändern, verschieben, löschen oder überschreiben Sie keine Vault-Dateien im Rahmen dieses Skills.
  • Stellen Sie --fix nicht als verfügbar dar. Die CLI beendet sich derzeit mit einem Fehler, wenn eine Fix-Ausführung versucht wird.
  • Löschen Sie keine verwaisten Anhänge, Duplikatskandidaten oder große Dateien automatisch. Fassen Sie die Beweise zusammen und empfehlen Sie eine manuelle Überprüfung.
  • Behandeln Sie title, message, generatedAt oder durationMs nicht als stabile Automatisierungs-IDs.
  • Verwenden Sie stabile Felder für die Automatisierung: schemaVersion, toolVersion, summary, scannerId, severity, primaryPath, relatedPaths, evidence, fingerprint, fixAction, isNew und summary.newIssues.
  • Leiten Sie den Scan-Fortschritt über stderr (--progress); stdout bleibt maschinenlesbar.

Wann Ausführen

Führen Sie Vault Inspector aus:

  • vor der Neuorganisation, Veröffentlichung, dem Export oder der Archivierung eines Vaults;
  • nach generierten oder agentengesteuerten Notizänderungen;
  • vor und nach Massenbearbeitungen von Links, Tags, Frontmatter oder Anhängen;
  • in CI, wenn ein Vault oder ein Repository mit generierten Dokumenten Regressionstests benötigt;
  • wenn ein Benutzer nach Vault-Hygiene, defekten Links, verwaisten Dateien, doppelten Dateien oder einer Analyse großer Dateien fragt.

Grundlegende Befehle

Von innerhalb eines Vaults:

vinspect . --format json

Für die einmalige Verwendung ohne globale Installation:

npx vault-inspector /pfad/zum/vault --format json

Schreiben Sie einen menschenlesbaren Bericht:

vinspect . --format markdown --output report.md

Führen Sie ausgewählte Scanner aus:

vinspect . --scanner broken-links,empty-notes,large-files --format json

Führen Sie den optionalen externen Link-Scanner nur aus, wenn Netzwerk-Checks akzeptabel sind:

vinspect . --scanner external-links --format json

Zeigen Sie den Fortschritt an, ohne stdout zu beschädigen:

vinspect . --format json --progress

Baseline-Workflow

Erstellen Sie eine Baseline:

vinspect . --format json --output .vault-inspector-baseline.json --fail-on none

Fehler nur bei neuen Funden auslösen:

vinspect . --baseline .vault-inspector-baseline.json --fail-on new --format json

Wenn eine Baseline verwendet wird, prüfen Sie summary.newIssues und das Feld isNew jedes Problems. Melden Sie neue Probleme vor bestehenden bekannten Problemen.

Exit-Codes

  • 0: Scan abgeschlossen und hat den konfigurierten --fail-on-Schwellenwert nicht erreicht.
  • 1: Scan abgeschlossen und hat den konfigurierten --fail-on-Schwellenwert erreicht.
  • 2: Ungültige CLI-Nutzung oder Fehler bei der Scan-Einrichtung.

Wenn der Exit-Code 2 ist, melden Sie den CLI-Fehler und interpretieren Sie stdout nicht als erfolgreiches Scan-Ergebnis.

Ergebnisinterpretation

Priorisieren Sie Funde in dieser Reihenfolge:

  1. Fehler (error) bei defekten Links und fehlenden Anhängen.
  2. Warnungen (warning), einschließlich fehlender Überschriften, großer Dateien, bestätigter Duplikate und älterer verwaister Anhänge.
  3. Informationen (info), einschließlich wenig genutzter Tags, übersprungener oder zeitlich ausgelaufener externer Checks, neuer verwaister Anhänge und Duplikatskandidaten.

Für jede Zusammenfassung fügen Sie hinzu:

  • Gesamtanzahl der Probleme;
  • Anzahl nach Schweregrad;
  • durchgeführte Scanner;
  • zuerst die Probleme mit hoher Sicherheit;
  • Dateipfade und Beweise, die für die manuelle Überprüfung benötigt werden;
  • Anzahl neuer Probleme durch Baseline, falls verfügbar.

Vermeiden Sie es, die Sicherheit der Ergebnisse zu überschätzen. Verwaiste Anhänge und Duplikatskandidaten können Fehlalarme sein, wenn Dateien von CSS, Canvas, Dataview, Publishing-Pipelines oder externen Tools referenziert werden.

Vorgeschlagene Agentenantwort

Verwenden Sie dieses Format für die Meldung von Scan-Ergebnissen:

Vault Inspector hat <N> Problem(e) gefunden: <E> Fehler, <W> Warnung(en), <I> Information(en).

Probleme mit höchster Priorität:
- [<severity>] <scannerId>: <primaryPath> - <kurze evidenzbasierte Erklärung>

Hinweise:
- <Hinweis zum Baseline/neuen Problem, falls relevant>
- <Hinweis zur manuellen Überprüfung bei verwaisten/duplikatskandidaten, falls relevant>

Wenn der Scan bestanden wird, geben Sie den ausgeführten Befehl und die relevanten Nullzahlen an. Behaupten Sie nicht, dass der Vault perfekt ist; sagen Sie, dass Vault Inspector keine Probleme mit den ausgewählten Scannern und Filtern gefunden hat.

Verwandte Skills