obsidian-cli

Automate Obsidian vault operations from the command line.

Updated Feb 11, 2016

Search Tags:#development #cli #plugin #obsidian #vault #notes #obsidian-cli

Ready to run

npx skills add https://github.com/Ehrax/dotfiles --skill obsidian-cli-ehrax

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/Ehrax/dotfiles/tree/main/configs/agents/skills/obsidian-cli
Command: npx skills add https://github.com/Ehrax/dotfiles --skill obsidian-cli-ehrax

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manage and automate Obsidian vaults from the command line, enabling rapid note creation, search, and vault operations without switching to the GUI.

Core Features & Use Cases

Interact with a running Obsidian instance via the obsidian CLI to read, create, search, and modify notes, tasks, properties, and more.
Develop and debug Obsidian plugins and themes from the terminal with commands to reload plugins, run JavaScript, capture errors, and inspect the DOM.
Automate workflows such as vault-wide searches, note templating, and batch updates across notes and metadata.

Quick Start

Install the Obsidian CLI, ensure Obsidian is running, and run a simple command to verify access.

Frequently Asked Questions about obsidian-cli

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I manage Obsidian vaults from the command line?▼

You can manage Obsidian vaults from the command line using a dedicated CLI to read, create, search, and modify notes and metadata. It requires a running Obsidian instance to automate tasks like vault-wide searches and batch updates without switching to the GUI.

Can I develop and debug Obsidian plugins from the terminal?▼

Yes, you can develop and debug Obsidian plugins from the terminal by running commands to reload plugins, execute JavaScript, capture errors, and inspect the DOM. This accelerates plugin and theme development workflows directly within your CLI environment.

Do I need Obsidian running to use CLI commands for note automation?▼

Yes, Obsidian must be running to use CLI commands for note automation. The command line interface interacts directly with your active Obsidian instance to execute vault operations, manage notes, and run JavaScript for development tasks.

What's the best way to automate note creation and vault-wide searches in Obsidian?▼

The best way to automate note creation and vault-wide searches in Obsidian is using a command line interface. It enables rapid note templating, batch metadata updates, and automated searches across your entire vault without manual GUI interaction.

Can I run JavaScript and inspect the DOM in Obsidian without the GUI?▼

Yes, you can run JavaScript and inspect the DOM in Obsidian without the GUI by using command line commands. This allows developers to capture errors, execute scripts, and debug plugin or theme behavior directly from the terminal.

What are the limitations of automating Obsidian vault operations via CLI?▼

The primary limitation of automating Obsidian vault operations via CLI is the strict dependency on having the Obsidian application actively running. If the instance is closed or unresponsive, command line interactions, note modifications, and plugin reloads will fail.