obsidian-cli

Automate Obsidian vault operations from the command line.

Updated May 5, 2025
One-click install
npx skills add https://github.com/yopitek/Obsidian --skill obsidian-cli-yopitek
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/yopitek/Obsidian/tree/main/HQ/10_resources/01_AI_Skills/Obsidian_skill/obsidian-cli
Command: npx skills add https://github.com/yopitek/Obsidian --skill obsidian-cli-yopitek

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Programmatic control of Obsidian vaults from the command line to read, create, search, and manage notes, tasks, properties, and more, enabling automation, batch updates, and development workflows without opening the app.

Core Features & Use Cases

  • Read / search vault content from the command line to surface notes, backlinks, and metadata.
  • Create / append notes, tasks, and properties, enabling batch generation and updates across multiple files.
  • Plugin/theme development: reload plugins, run JavaScript, capture errors, take screenshots, and inspect the DOM for debugging.
  • Use cases include automated vault maintenance, bulk note creation, and automated plugin testing.

Quick Start

Install the obsidian-cli, ensure Obsidian is running, and run obsidian help to see all commands.

Frequently Asked Questions about obsidian-cli

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

FAQPage Schema
How do I automate Obsidian vault management from the command line?

You can automate Obsidian vault management from the command line by sending commands to a running instance to batch create, search, and update notes and properties without opening the app interface.

Can I batch create notes and update properties in an Obsidian vault without opening the app?

Yes, you can batch create notes, append tasks, and manipulate properties in an Obsidian vault without opening the app by executing CLI commands against the running background instance.

Does Obsidian CLI support plugin development workflows like reloading and DOM inspection?

Obsidian CLI supports plugin development workflows by enabling you to reload plugins, run JavaScript, capture errors, inspect the DOM, and take screenshots for debugging directly from the command line.

What is the best way to run automated tests on Obsidian plugins and themes?

The best way to run automated tests on Obsidian plugins and themes is using CLI commands to reload plugins, execute JavaScript, capture errors, and take screenshots of the running instance for debugging.

Do I need Obsidian running to use CLI commands for vault search and note creation?

Yes, you need a running Obsidian instance because the CLI automates interaction by sending commands to the active application to read, create, search, and manage vault content.