obsidian-cli
Interact with Obsidian vaults using the Obsidian CLI to read, create, search, and manage notes, tasks, properties, and more. Also supports plugin and theme development with commands to reload plugins, run JavaScript, capture errors, take screenshots, and inspect the DOM. Use when the user asks to interact with their Obsidian vault, manage notes, search vault content, perform vault operations from the command line, or develop and debug Obsidian plugins and themes.
Security Assessment
About obsidian-cli
The obsidian-cli skill enables users to interact with their Obsidian vaults directly from the command line, offering a streamlined way to manage notes, tasks, properties, and other vault content without manually navigating the app. By using this CLI, users can perform operations such as creating, reading, appending, and searching notes, as well as targeting specific files or entire vaults. This skill solves the problem of efficiently automating and scripting common Obsidian workflows, making it particularly useful for users who prefer command-line interfaces or need to integrate Obsidian tasks into larger automation pipelines.
The skill provides a comprehensive set of features that cover both general vault management and advanced plugin development. Users can create and modify notes, search vault content with query limits, manage daily notes, set and retrieve properties, handle tasks, sort tags, and view backlinks. For developers, obsidian-cli supports plugin and theme workflows, including reloading plugins, checking for errors, taking screenshots, inspecting the DOM, evaluating JavaScript within the app context, toggling mobile emulation, and inspecting CSS values. Commands can include parameters for specific files or paths, vault targeting, and flags such as silent mode or clipboard copying.
Typical use cases include automating note creation and updates, performing batch searches or property edits, managing daily tasks, and developing or testing plugins and themes for Obsidian. Target users include Obsidian power users, developers building plugins or custom themes, productivity enthusiasts, and anyone who wants to integrate Obsidian into automated workflows. This skill is particularly suited for those familiar with command-line operations who seek efficiency, reproducibility, and programmatic control over their Obsidian vaults.
FAQ
Do I need Obsidian open to use obsidian-cli?
Yes, obsidian-cli requires a running instance of Obsidian. Commands will interact with the currently focused or specified vault in the open app.
Can I target a specific vault or note with commands?
Yes, you can specify a vault using the vault parameter and target files either by name with file= or exact path with path=.
How do I include multiline content in a note?
Use the escape sequences \n for newlines and \t for tabs when providing content in commands.
Are there developer-specific commands for plugin and theme testing?
Yes, commands exist for reloading plugins, checking errors, capturing screenshots, inspecting the DOM, evaluating JavaScript, toggling mobile emulation, and inspecting CSS values.
Can output be copied directly to the clipboard?
Yes, adding the --copy flag to any command will copy the command output to the clipboard.
Install obsidian-cli
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
kepano/obsidian-skills