obsidian-cli

Execute Obsidian subcommands to read, create, search, and manage vault notes.

Updated Jul 11, 2022
One-click install
npx skills add https://github.com/zhengfran/dotconfig --skill obsidian-cli-zhengfran
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/zhengfran/dotconfig/tree/main/tools/ai/agents/skills/obsidian-cli
Command: npx skills add https://github.com/zhengfran/dotconfig --skill obsidian-cli-zhengfran

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Obsidian vault management becomes slow and error-prone when creating, updating, searching, or organizing notes entirely by hand, especially when you need repeatable automation.

Core Features & Use Cases

  • Read and write vault content: Create notes, append text, read files, and edit frontmatter and properties to keep knowledge organized.
  • Search and task operations: Search across the vault, work with daily notes, query tasks, and manage tags for fast retrieval.
  • Plugin/theme development support: Reload plugins, evaluate JavaScript, capture screenshots, inspect the DOM, and check for development errors to debug from the command line.

Quick Start

Use the obsidian CLI to read a note by running: obsidian read file="My Note".

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 content from the command line?

You can manage Obsidian vault content from the command line by executing subcommands to read, create, search, and update notes, including appending text and editing properties. This requires a running Obsidian instance to function properly.

Can I automate daily notes and task queries in Obsidian without opening the app UI?

Yes, you can automate daily notes and task queries in Obsidian without opening the app UI by running command-line subcommands to search across the vault, query tasks, and manage tags for fast retrieval.

Does Obsidian CLI require a running instance to execute vault automation scripts?

Yes, Obsidian CLI requires a running instance to execute vault automation scripts. You must have Obsidian open and can specify target vaults and file paths while executing the appropriate subcommands.

What is the best way to debug Obsidian plugin development from the terminal?

The best way to debug Obsidian plugin development from the terminal is using command-line interaction to reload plugins, evaluate JavaScript, inspect the DOM, capture screenshots, and check for development errors.

How do I edit frontmatter and properties in Obsidian notes via CLI?

You can edit frontmatter and properties in Obsidian notes via CLI by running subcommands that directly target file paths to update metadata, keeping your knowledge base organized through repeatable automation.