obsidian-cli

Control Obsidian vaults from the command line to manage notes, tasks, and plugins.

Updated Mar 31, 2026
One-click install
npx skills add https://github.com/magarcia/pylon-sync --skill obsidian-cli-magarcia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/magarcia/pylon-sync/tree/main/.agents/skills/obsidian-cli
Command: npx skills add https://github.com/magarcia/pylon-sync --skill obsidian-cli-magarcia

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Operating an Obsidian vault typically demands manual GUI interaction, so this skill exposes the obsidian CLI to automate note management, search, and plugin workflows directly from the terminal.

Core Features & Use Cases

  • Vault navigation: Specify vault names, read files, search content, and create or append notes without leaving the command line.
  • Task and metadata control: Update properties, manage task lists, and run dedicated commands such as tasks, property:set, daily:append, and backlinks to keep structured data in sync.
  • Plugin development: Reload plugins, capture errors, run JavaScript evaluations, take screenshots, and inspect the DOM to streamline theme or plugin debugging cycles.
  • Use Case: While developing an Obsidian plugin, chain plugin:reload, dev:errors, and dev:screenshot to verify changes, identify regressions, and document UI updates without toggling away from the terminal.

Quick Start

Launch the obsidian CLI and run obsidian read file=My Note to display the note contents in the terminal.

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?

Obsidian vault management from the command line is achieved by using the obsidian CLI to navigate vaults, read and write notes, and update properties without GUI interaction. This requires a running Obsidian instance with the target vault open.

Can I automate Obsidian task tracking and metadata updates in the terminal?

Obsidian task tracking and metadata updates can be automated in the terminal using dedicated CLI commands like tasks, property:set, and daily:append to keep structured data synchronized directly from the command line.

What is the best way to debug an Obsidian plugin without leaving the terminal?

Debugging an Obsidian plugin from the terminal is done by chaining obsidian CLI commands like plugin:reload, dev:errors, and dev:screenshot to verify changes, identify regressions, and inspect the DOM without toggling away from the command line.

Does the obsidian CLI work with a closed vault?

The obsidian CLI does not work with a closed vault. It requires the obsidian CLI to be installed and the target Obsidian vault to be actively open and running to execute vault navigation, file operations, and plugin diagnostics.

How do I search and read note contents in an Obsidian vault via CLI?

Reading note contents in an Obsidian vault via CLI is done by launching the obsidian CLI and running commands like obsidian read file=My Note to display the note contents directly in the terminal output.

Are there limitations when using terminal automation for Obsidian note management?

Limitations of terminal automation for Obsidian note management include a strict dependency on having the Obsidian application running with the target vault open, meaning the CLI cannot operate headlessly or manage vaults in the background.