obsidian-cli

Manage Obsidian vaults via command-line for notes, search, and plugin development.

Updated Jun 25, 2023
One-click install
npx skills add https://github.com/iwbc-mzk/obsidian --skill obsidian-cli-iwbc-mzk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/iwbc-mzk/obsidian/tree/main/.claude/skills/obsidian-cli
Command: npx skills add https://github.com/iwbc-mzk/obsidian --skill obsidian-cli-iwbc-mzk

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill allows users to interact with and manage their Obsidian vaults directly from the command line, streamlining note-taking, organization, and plugin development workflows.

Core Features & Use Cases

  • Note Management: Create, read, append, and delete notes within Obsidian vaults.
  • Search & Organization: Search vault content, manage tags, and set file properties.
  • Plugin Development: Reload plugins, capture errors, take screenshots, and inspect the DOM for Obsidian plugin and theme development.
  • Use Case: Quickly create a new daily note, append a task to an existing note, or search your entire vault for a specific keyword without opening the Obsidian application GUI.

Quick Start

Use the obsidian-cli skill to create a new note named "Meeting Notes" with the content "Discussed project roadmap."

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?

You can manage Obsidian vaults from the command line by using this Skill to create, read, append, and delete notes, as well as search content and manage file properties without opening the GUI.

Can I develop Obsidian plugins using a CLI?

Yes, you can develop Obsidian plugins using this CLI to reload plugins, capture errors, take screenshots, inspect the DOM, and debug themes during your development workflow.

Do I need the Obsidian application running to use a CLI for vault management?

Yes, the Obsidian application must be running for most CLI operations. The command-line interface interacts with the active application to execute vault management and plugin debugging commands.

What is the best way to search notes and append tasks in an Obsidian vault without opening the app?

The best way to search notes and append tasks without opening the app is using this CLI Skill to query vault content for specific keywords and directly append tasks to existing markdown files.

Does the Obsidian CLI support setting markdown file properties and tags?

Yes, the Obsidian CLI supports markdown file property management by allowing you to set file properties and manage tags directly through command-line operations on your vault.

What are the limitations of using a command line interface for Obsidian note management?

A limitation of using a command line interface for Obsidian note management is that the Obsidian desktop application must remain actively running in the background to execute vault and plugin commands.