obsidian-cli

Manage Obsidian vault notes, tasks, and properties from the terminal.

Updated Feb 2, 2016

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

Ready to run

npx skills add https://github.com/zjykzk/blog --skill obsidian-cli-zjykzk

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Obsidian vault management can be slow and error-prone when using only GUI actions; this CLI enables fast, repeatable operations from the terminal.

Core Features & Use Cases

Read notes, search the vault, and retrieve metadata programmatically.
Create and update notes, tasks, and properties from scripts.
Reload plugins and themes, run JavaScript, capture errors, take screenshots, and inspect the DOM for plugin/theme development and debugging.
Automate routine vault workflows and support end-to-end development tasks from the command line.

Quick Start

Use the obsidian-cli to read or create notes directly from 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 vault content from the command line?▼

You can manage Obsidian vault content from the command line by using a CLI to read, create, search, and update notes, tasks, and properties programmatically. This enables fast, repeatable terminal operations without GUI interactions.

Can I debug Obsidian plugins from the terminal?▼

Yes, you can debug Obsidian plugins from the terminal by running JavaScript, capturing errors, inspecting the DOM, taking screenshots, and reloading plugins directly. This supports end-to-end plugin and theme development workflows.

Does the Obsidian CLI require a running instance to automate vault tasks?▼

Yes, automating vault tasks with the Obsidian CLI requires access to a running Obsidian instance. This connection allows scripts to execute commands, manipulate notes, and retrieve metadata programmatically.

What is the best way to automate routine workflows in an Obsidian vault?▼

The best way to automate routine workflows in an Obsidian vault is using a CLI for fast, repeatable operations. It enables you to script note creation, metadata retrieval, and task updates directly from the terminal.

Why use a command line interface instead of the Obsidian GUI for vault management?▼

Use a command line interface for Obsidian vault management because GUI actions can be slow and error-prone. A CLI enables fast, repeatable operations, allowing you to automate routine workflows and support development tasks from the terminal.