Skip to content

obx doctor

The obx doctor command analyzes your vault for structural issues, such as broken wikilinks or notes that have no incoming or outgoing connections.

Terminal window
obx doctor [flags] [vault_path]
FlagShorthandDescriptionDefault
--fail-fExit with a non-zero status code if any issues are found. Ideal for CI/CD pipelines.false
Terminal window
obx doctor

Output:

Running vault diagnostics on /Users/zach/MyVault...
Broken Links:
- research/ai-notes.md -> non-existent-note
Orphan Notes:
- random-thoughts/2023-11-01.md

To fail a GitHub Actions workflow if your vault contains broken links:

Terminal window
obx doctor --fail