home / skills / bahayonghang / my-claude-code-settings / obsidian-cli
This skill helps you manage Obsidian vaults from the command line, enabling read, create, search, and plugin debugging tasks.
npx playbooks add skill bahayonghang/my-claude-code-settings --skill obsidian-cliReview the files below or copy the command above to add this skill to your agents.
---
name: obsidian-cli
description: Interact with Obsidian vaults using the Obsidian CLI to read, create, search, and manage notes, tasks, properties, and more. Also supports plugin and theme development with commands to reload plugins, run JavaScript, capture errors, take screenshots, and inspect the DOM. Use when the user asks to interact with their Obsidian vault, manage notes, search vault content, perform vault operations from the command line, or develop and debug Obsidian plugins and themes.
---
# Obsidian CLI
Use the `obsidian` CLI to interact with a running Obsidian instance. Requires Obsidian to be open.
## Command reference
Run `obsidian help` to see all available commands. This is always up to date. Full docs: https://help.obsidian.md/cli
## Syntax
**Parameters** take a value with `=`. Quote values with spaces:
```bash
obsidian create name="My Note" content="Hello world"
```
**Flags** are boolean switches with no value:
```bash
obsidian create name="My Note" silent overwrite
```
For multiline content use `\n` for newline and `\t` for tab.
## File targeting
Many commands accept `file` or `path` to target a file. Without either, the active file is used.
- `file=<name>` — resolves like a wikilink (name only, no path or extension needed)
- `path=<path>` — exact path from vault root, e.g. `folder/note.md`
## Vault targeting
Commands target the most recently focused vault by default. Use `vault=<name>` as the first parameter to target a specific vault:
```bash
obsidian vault="My Vault" search query="test"
```
## Common patterns
```bash
obsidian read file="My Note"
obsidian create name="New Note" content="# Hello" template="Template" silent
obsidian append file="My Note" content="New line"
obsidian search query="search term" limit=10
obsidian daily:read
obsidian daily:append content="- [ ] New task"
obsidian property:set name="status" value="done" file="My Note"
obsidian tasks daily todo
obsidian tags sort=count counts
obsidian backlinks file="My Note"
```
Use `--copy` on any command to copy output to clipboard. Use `silent` to prevent files from opening. Use `total` on list commands to get a count.
## Plugin development
Reload a plugin after code changes — essential for the develop/test cycle:
```bash
obsidian plugin:reload id=my-plugin
```
Run JavaScript in the app context:
```bash
obsidian eval code="app.vault.getFiles().length"
```
Check for errors and console output:
```bash
obsidian dev:errors
obsidian dev:console
obsidian dev:console level=error
```
Take a screenshot for visual testing:
```bash
obsidian dev:screenshot path=screenshot.png
```
Inspect DOM and CSS:
```bash
obsidian dev:dom selector=".workspace-leaf" text
obsidian dev:css selector=".workspace-leaf" prop=background-color
```
Toggle mobile emulation:
```bash
obsidian dev:mobile on
```
Run `obsidian help` to see additional developer commands including CDP and debugger controls.
This skill provides command-line access to an open Obsidian vault using the Obsidian CLI. It lets you read, create, search, and modify notes, tasks, and properties, and includes developer commands for reloading plugins, running JS, capturing errors, and inspecting the DOM. Use it to automate vault operations or speed up plugin and theme development workflows.
Commands are sent to a running Obsidian instance and target either the active file, a named file (wikilink-style), or an exact path. Parameters use key=value, flags are boolean, and multiline content uses \n/\t. Developer commands run inside the app context, expose console/errors, allow screenshots, and query DOM/CSS properties.
Do I need Obsidian open to use this skill?
Yes. The CLI communicates with a running Obsidian instance, so the app must be open and focused on the desired vault.
How do I target a specific vault?
Pass vault=<name> as the first parameter to target a specific vault; otherwise the most recently focused vault is used.