CLI Overview
While obx is primarily an MCP server, it also provides a powerful command-line interface for interacting with your Obsidian vault directly from your terminal. This is useful for scripting, quick lookups, or vault maintenance without needing an AI assistant.
Available Commands
Section titled “Available Commands” obx search Full-text search across your vault with compact or detailed output.
obx doctor Analyze your vault for broken links and orphaned notes.
obx daily Quickly create or append to your daily note.
obx vault Manage your configured vault aliases globally.
obx mcp Start the MCP server for AI clients.
Global Flags
Section titled “Global Flags”All obx commands support the following global options:
--help,-h: Show help for a command.
Environment Variables
Section titled “Environment Variables”You can configure obx behavior using environment variables to avoid passing flags repeatedly:
OBSIDIAN_VAULT_PATH: Sets the default vault path if one is not provided as an argument and no active vault is configured viaobx vault.OBSIDIAN_ADDR: Sets the HTTP address forobx mcp --http.