What problem does it solve?
Obsidian CLI enables you to control a running Obsidian desktop app from the terminal, making it easy to automate vault/file operations, run commands, and interact with URIs without manual clicks.
Core Features & Use Cases
- Official desktop CLI for single commands and an interactive TUI to manage vaults, notes, searches, and developer tasks.
- Vault and file targeting with
vault= ordering and file=/path= resolution for precise automation across multiple vaults.
- URI integration with
obsidian:// for opening, creating, and wiring callback-based workflows, including encoding rules and x-success/x-error hooks.
- Developer tooling support with commands like
plugin:reload, devtools, dev:screenshot, and eval for plugin and theme workflows.
- Desktop-bound automation vs Headless workflows, clarifying when the CLI applies to the running app versus separate headless usage.
Quick Start
Install and enable the Obsidian CLI from the desktop app, then use the terminal to run commands against a vault.