obsidian-cli

Name: obsidian-cli
Availability: InStock
Author: Selogaz

Control an Obsidian vault from the command line to read, create, search, and manage notes.

Updated Dec 26, 2023

Search Tags:#automation #cli #obsidian #vault #notes #plugin-development #dom-inspection

Ready to run

npx skills add https://github.com/Selogaz/Obsidian-vault-cpp --skill obsidian-cli-selogaz

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/Selogaz/Obsidian-vault-cpp/tree/main/skills/obsidian-cli
Command: npx skills add https://github.com/Selogaz/Obsidian-vault-cpp --skill obsidian-cli-selogaz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This CLI tool enables you to manage Obsidian vaults from outside the UI, empowering you to read, create, search, and organize notes, tasks, and properties at scale.

Core Features & Use Cases

Read and create notes, tasks, and properties directly from the command line.
Search vault content, inspect links and metadata, and automate routine vault operations.
Develop and debug Obsidian plugins and themes with commands to reload plugins, run JavaScript, capture errors, take screenshots, and inspect the DOM.

Quick Start

Open an Obsidian vault with CLI enabled and run a simple command like obsidian read file="My 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 vaults from the command line?▼

Obsidian vaults can be managed from the command line by using a CLI tool to read, create, search, and organize notes, tasks, and properties. The CLI operates while Obsidian is running, enabling remote vault operations without opening the UI.

Can I automate note creation and batch processing in Obsidian without opening the app?▼

Yes, note creation and batch processing in Obsidian can be automated without opening the app by executing CLI commands. This allows you to handle routine vault operations and scale your workflow programmatically.

What is the best way to debug and reload an Obsidian plugin during development?▼

Debugging and reloading an Obsidian plugin during development is best achieved using a CLI tool that supports plugin reloading, JavaScript execution, error capture, DOM inspection, and screenshots. This enables efficient debugging without manual UI interaction.

Does the Obsidian CLI work when the Obsidian app is closed?▼

No, the Obsidian CLI requires the app to be running in the background to execute commands, manage vault content, and perform actions like taking screenshots or inspecting the DOM.

How do I search for notes and inspect metadata in an Obsidian vault remotely?▼

Searching for notes and inspecting metadata in an Obsidian vault remotely is done by running CLI commands. This allows you to query vault content, inspect links, and retrieve properties directly from the terminal.

Why do I need a command line tool for Obsidian if I can use the graphical interface?▼

A command line tool for Obsidian is needed to handle automation workflows, batch processing of notes, and remote vault management that the graphical interface cannot perform efficiently. It also provides specialized development tools like DOM inspection and JavaScript execution.