obsidian-cli

Reads, creates, searches, and manages notes in Obsidian vaults via the Obsidian CLI.

1|Updated Jul 2, 2023

Search Tags:#debugging #cli #obsidian #vault #notes #plugin-development #dom-inspection

Ready to run

npx skills add https://github.com/danburonline/public-notes --skill obsidian-cli-danburonline

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/danburonline/public-notes/tree/main/.agents/skills/obsidian-cli
Command: npx skills add https://github.com/danburonline/public-notes --skill obsidian-cli-danburonline

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates vault management tasks for Obsidian by enabling CLI-based interactions with vaults, notes, and plugins to save time and reduce UI switching.

Core Features & Use Cases

Read, create, search, and manage notes in an Open Obsidian vault from the command line.
Manage tasks and metadata within notes, and perform batch operations across multiple notes.
Use for plugin and theme development workflows, debugging, and automation by reloading plugins, executing JavaScript in the app context, capturing errors, taking screenshots, and inspecting the DOM.

Quick Start

Ask Obsidian to read the note 'Welcome' using the CLI to verify vault integration.

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 vault notes from the command line?▼

You can manage Obsidian vault notes from the command line by using the CLI to read, create, search, and batch update notes directly in an open vault. This requires Obsidian to be running and targets vaults through file names or paths.

Can I automate Obsidian plugin development workflows via the CLI?▼

Yes, you can automate Obsidian plugin development workflows via the CLI by reloading plugins, executing JavaScript in the app context, capturing errors, taking screenshots, and inspecting the DOM while the vault is open.

Does the Obsidian CLI require the app to be open to search notes?▼

Yes, the Obsidian CLI requires the app to be open to search notes and perform vault operations. It interacts with the active vault session by targeting specific file names or paths from the command line.

What is the best way to debug an Obsidian theme without UI switching?▼

The best way to debug an Obsidian theme without UI switching is using CLI commands to execute JavaScript, capture errors, take screenshots, and inspect the DOM directly from the terminal while the vault is open.

How do I run JavaScript in the Obsidian app context from a terminal?▼

You can run JavaScript in the Obsidian app context from a terminal by using CLI commands to execute scripts, inspect the DOM, and capture errors within the active vault environment. This enables automated debugging and vault manipulation.

Are there limitations when performing batch operations on Obsidian notes via the CLI?▼

The primary limitation when performing batch operations on Obsidian notes via the CLI is that the Obsidian application must remain open, as the commands target vaults through file names or paths within the active session.