What does the Obsidian CLI skill do?

It uses the `obsidian` CLI to interact with a running Obsidian instance for shell-driven vault management, plugin development, and theme debugging. Obsidian must already be open for the CLI to work.

How do I target a specific file or vault with Obsidian CLI commands?

Use `file= ` (resolved like a wikilink) or `path= ` (exact vault-root-relative path) to target files; without either, the active file is used. For vaults, use `vault= ` as the first parameter, or it defaults to the most recently focused vault.

What commands are available for plugin development and debugging?

You can reload a plugin with `obsidian plugin:reload id=my-plugin`, check for errors with `obsidian dev:errors`, take screenshots with `obsidian dev:screenshot`, inspect the DOM with `obsidian dev:dom`, check console output with `obsidian dev:console`, and toggle mobile emulation with `obsidian dev:mobile on`.

What are some common vault management commands?

Common commands include `obsidian read file="My Note"` to read a note, `obsidian create name="New Note" content="# Hello"` to create one, `obsidian search query="search term"` to search, `obsidian daily:read` to read the daily note, and `obsidian property:set name="status" value="done"` to set properties.

Does the Obsidian CLI require Obsidian to be running?

Yes, the CLI requires an active Obsidian instance to be running. It is not needed when Obsidian isn't open.

Skill

Automate Obsidian Vault Management and Plugin Development

Name: Obsidian CLI
Availability: OnlineOnly
Author: Antigravity

Obsidian CLI drives a running Obsidian instance from the shell - notes, search, daily notes, and plugin development.

Get skill

Works with obsidian

Antigravity

Own this? Claim it

Spark score

out of 100

Updated 3 days ago

Version 15.5.1

Add to Favorites

Why it matters

Streamline your Obsidian vault management and plugin development process. This skill allows you to interact with a running Obsidian instance via the command line, automating tasks like note creation, content management, and plugin debugging.

Outcomes

What it gets done

Manage Obsidian vault content (create, read, append, search notes).

Automate Obsidian plugin and theme development cycles (reload, error checking, visual verification).

Execute custom JavaScript code within the Obsidian app context.

Inspect and manipulate Obsidian's CSS and mobile emulation settings.

Install

Add it to your toolbox

Run in your project directory:

curl -fsSL https://spark.entire.vc/get/ag-obsidian-cli | bash

Overview

Obsidian CLI

Obsidian CLI drives a running Obsidian instance from the shell - reading, creating, and searching notes, plus a plugin/theme reload-test-inspect development workflow. Use it for shell-driven vault management or plugin/theme development against a live Obsidian instance. Requires Obsidian to already be open.

What it does

Obsidian CLI is a command-line interface (obsidian) for driving a running Obsidian instance from the shell - reading, creating, and appending to notes, searching the vault, managing daily notes and properties, and inspecting tags and backlinks - plus a full plugin and theme development workflow (reload, error checking, visual verification, console inspection). It requires Obsidian to already be open, and obsidian help always reflects the current, up-to-date command list.

When to use - and when NOT to

Use it for managing vault content through the CLI, developing or debugging an Obsidian plugin or theme from the command line, or any shell-driven interaction with a running Obsidian app. It is the CLI-specific tool in this space, distinct from working with Obsidian's Bases (.base YAML files) or writing in Obsidian's own Markdown syntax such as wikilinks and callouts - this skill is purely about driving the running application via shell commands.

Inputs and outputs

Input: a command with key=value parameters, quoted if they contain spaces, and boolean flags with no value - \n and \t for multiline content, file=<name> to target a note by wikilink-style name or path=<path> for an exact vault-root path, defaulting to the active file if neither is given, and vault=<name> as the first parameter to target a non-default vault. Output: the result of the command, optionally copied to the clipboard with --copy, run without opening the file via silent, or counted via total on list commands.

obsidian create name="New Note" content="# Hello" template="Template" silent

For plugin and theme development specifically, it follows a fixed reload-check-verify-inspect cycle: obsidian plugin:reload id=my-plugin to pick up code changes, obsidian dev:errors to catch failures (repeating from reload if any appear), obsidian dev:screenshot or obsidian dev:dom to verify visually, and obsidian dev:console level=error to check for warnings - plus obsidian eval code="..." to run arbitrary JavaScript in the app context, obsidian dev:css to inspect computed CSS values, and obsidian dev:mobile on to toggle mobile emulation.

Integrations

Wraps Obsidian's own CLI surface (help.obsidian.md/cli) and its developer and debug commands, including CDP and debugger controls surfaced via obsidian help.

Who it's for

Obsidian users automating vault management from the shell - searching with a result limit, reading and appending the active or a named file, working with daily notes and note properties - and plugin or theme developers who want a fast reload-test-inspect loop against a live, running Obsidian instance instead of manually reloading and clicking through the UI.

FAQ

Common questions

Discussion