obsidian-cli

Manage Obsidian notes, tasks, and metadata via the obsidian CLI.

Updated Oct 10, 2023
One-click install
npx skills add https://github.com/kirakuiin/note --skill obsidian-cli-kirakuiin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/kirakuiin/note/tree/main/Obsidian%20Vault/9-Meta/Skills/obsidian-cli
Command: npx skills add https://github.com/kirakuiin/note --skill obsidian-cli-kirakuiin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This tool enables command-line interactions with Obsidian vaults, letting users read, create, search, and manage notes, tasks, and metadata without opening the GUI, accelerating automation and development workflows.

Core Features & Use Cases

  • Read, write, and search notes from the command line across vaults.
  • Manage tasks, properties, and metadata programmatically, enabling batch operations and integration with external tooling.
  • Develop and debug Obsidian plugins and themes using CLI commands for reloads, JavaScript execution, error capture, screenshots, and DOM inspection.

Quick Start

Use the obsidian-cli to run a sample command against your active vault to read a note.

Frequently Asked Questions about obsidian-cli

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate Obsidian vault maintenance from the command line?

You can automate Obsidian vault maintenance from the command line by using this tool to programmatically read, create, search, and manage notes, tasks, and metadata without opening the GUI.

Can I reload Obsidian plugins and inspect the DOM via CLI?

Yes, you can reload Obsidian plugins and inspect the DOM via CLI. The tool exposes commands to reload plugins, run JavaScript, capture errors, take screenshots, and inspect the DOM for plugin and theme development.

Does the Obsidian CLI require the Obsidian app to be open?

Yes, the Obsidian CLI requires the Obsidian app to be open. It relies on the active application to execute programmatic interactions against your vault for reading, creating, and managing notes.

What is the best way to run batch operations on Obsidian notes?

The best way to run batch operations on Obsidian notes is using a command-line interface that manages tasks, properties, and metadata programmatically. This enables automated vault maintenance and external tooling integration.

How do I capture errors and take screenshots when developing Obsidian themes?

To capture errors and take screenshots when developing Obsidian themes, use the CLI commands designed for debugging. It supports JavaScript execution, error capture, screenshots, and DOM inspection during plugin and theme development.