obsidian-cli

Manage Obsidian vaults and automate plugin development workflows from the command line.

1|Updated Mar 8, 2024
One-click install
npx skills add https://github.com/cpp-for-everything/ORM --skill obsidian-cli-cpp-for-everything
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/cpp-for-everything/ORM/tree/main/.windsurf/skills/obsidian-cli
Command: npx skills add https://github.com/cpp-for-everything/ORM --skill obsidian-cli-cpp-for-everything

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Interact with Obsidian vaults from the terminal to read, create, search, and manage notes, tasks, properties, and more, without relying on the GUI. It also supports plugin and theme development with commands to reload plugins, run JavaScript, capture errors, take screenshots, and inspect the DOM.

Core Features & Use Cases

  • Read and create notes, search vault content, and manage tasks and properties from scripts or quick commands.
  • Develop and test Obsidian plugins and themes with commands to reload plugins, run JavaScript, capture errors, and inspect the DOM.
  • Use in automation workflows to integrate Obsidian with other tools or CI environments, or to perform vault operations from the command line.

Quick Start

Open a terminal and run obsidian help to see all commands and start with a simple operation like obsidian read file="Welcome 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 notes from the command line?

You can manage Obsidian vault notes from the command line by using a CLI interface to read, create, search, and manage notes, tasks, and metadata without relying on the GUI.

Can I automate Obsidian vault operations in CI environments?

Yes, you can automate Obsidian vault operations in CI environments by integrating the command-line interface with other tools to script rapid content management across projects.

How do I test Obsidian plugins and themes from the terminal?

You test Obsidian plugins and themes from the terminal by running developer CLI commands to reload plugins, execute JavaScript, capture errors, take screenshots, and inspect the DOM.

What is the best way to search vault content without opening the Obsidian GUI?

The best way to search vault content without the GUI is using a command-line interface that targets vaults directly to query and retrieve notes, tasks, and properties.

Does the Obsidian CLI require any specific dependencies to function?

No, the Obsidian CLI operates independently without requiring any external dependencies to manage vault files and execute developer utilities.

Why use a command-line interface for Obsidian vault operations instead of the GUI?

Using a command-line interface for Obsidian vault operations allows you to script workflows, automate content management, and test plugins rapidly across projects where GUI access is unavailable.