obsidian-cli
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 in
By kepano · 74,452 installs
npx skills add kepano/obsidian-skills --skill obsidian-cli
Source repository · Upstream listing
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:
Flags are boolean switches with no value:
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:
Common patterns
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
Develop/test cycle
After making code changes to a plugin or theme, follow this workflow:
1. Reload the plugin to pick up changes:
2. Check for errors — if errors appear, fix and repeat from step 1:
3. Verify visually with a screenshot or DOM inspection:
4. Check console output for warnings or unexpected logs:
Additional developer commands
Run JavaScript in the app context:
Inspect CSS values:
Toggle mobile emulation:
Run obsidian help to see additional developer commands including CDP and debugger controls.