obsidian-cli

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

Updated Oct 7, 2022
One-click install
npx skills add https://github.com/tamagusko/linux-cfg --skill obsidian-cli-tamagusko
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: obsidian-cli
Source: https://github.com/tamagusko/linux-cfg/tree/main/dotfiles/claude/skills/obsidian-cli
Command: npx skills add https://github.com/tamagusko/linux-cfg --skill obsidian-cli-tamagusko

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Managing an Obsidian vault and debugging plugins normally requires manual clicking inside the app. This Skill lets you read, create, search, and update notes, tasks, and properties directly from the command line, and gives plugin developers a scripted reload-test-inspect loop. ## Core Features & Use Cases - Vault Operations: Read, create, append to, and search notes, set properties, manage daily notes and tasks, and inspect tags and backlinks using the obsidian CLI. - Plugin & Theme Development: Reload plugins, capture errors, take screenshots, inspect the DOM and CSS, run JavaScript in the app context, and read console output. - Use Case: While developing an Obsidian plugin, run obsidian plugin:reload id=my-plugin, check obsidian dev:errors, and verify the UI with obsidian dev:screenshot after every code change without touching the app window. ## Quick Start Ask the assistant to use the obsidian CLI to append a new task to today's daily note in your vault.

Frequently Asked Questions about obsidian-cli

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

FAQPage Schema
How do I create or edit Obsidian notes from the command line?

Use the obsidian CLI with commands like `obsidian create name="My Note" content="Hello"` or `obsidian append file="My Note" content="New line"`. Parameters take values with `=`, and multiline content uses \n for newlines.

How do I search my Obsidian vault from the terminal?

Run `obsidian search query="search term" limit=10` to search vault content. You can target a specific vault by adding `vault="Vault Name"` as the first parameter, and use `--copy` to copy results to the clipboard.

Does the Obsidian CLI work when Obsidian is closed?

No, the obsidian CLI requires a running Obsidian instance to interact with. Commands target the most recently focused vault unless you specify one with the `vault` parameter.

How do I reload and debug an Obsidian plugin during development?

Run `obsidian plugin:reload id=my-plugin` after code changes, then check `obsidian dev:errors` for failures. Verify visually with `obsidian dev:screenshot` or `obsidian dev:dom`, and inspect logs with `obsidian dev:console`.

What is the difference between file and path parameters in the Obsidian CLI?

The `file` parameter resolves like a wikilink using just the note name, while `path` requires the exact path from the vault root such as `folder/note.md`. Without either, commands operate on the currently active file.