obsidian-cli
npx machina-cli add skill guanyang/antigravity-skills/obsidian-cli --openclawObsidian 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:
obsidian create name="My Note" content="Hello world"
Flags are boolean switches with no value:
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:
obsidian vault="My Vault" search query="test"
Common patterns
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
Develop/test cycle
After making code changes to a plugin or theme, follow this workflow:
- Reload the plugin to pick up changes:
obsidian plugin:reload id=my-plugin - Check for errors — if errors appear, fix and repeat from step 1:
obsidian dev:errors - Verify visually with a screenshot or DOM inspection:
obsidian dev:screenshot path=screenshot.png obsidian dev:dom selector=".workspace-leaf" text - Check console output for warnings or unexpected logs:
obsidian dev:console level=error
Additional developer commands
Run JavaScript in the app context:
obsidian eval code="app.vault.getFiles().length"
Inspect CSS values:
obsidian dev:css selector=".workspace-leaf" prop=background-color
Toggle mobile emulation:
obsidian dev:mobile on
Run obsidian help to see additional developer commands including CDP and debugger controls.
Source
git clone https://github.com/guanyang/antigravity-skills/blob/main/skills/obsidian-cli/SKILL.mdView on GitHub Overview
Obsidian CLI lets you read, create, search, and manage notes, tasks, and properties directly from the command line. It also supports plugin and theme development with commands to reload plugins, run JavaScript, capture errors, take screenshots, and inspect the DOM. This makes automation, rapid vault operations, and in-context debugging possible without opening the Obsidian UI.
How This Skill Works
Install Obsidian and run the obsidian CLI against a running Obsidian instance. Commands target the most recently focused vault by default, with options to specify vault=<name> and file=<name> or path=<path> for precise targeting. For development tasks, use commands like plugin:reload, dev:errors, dev:screenshot, dev:dom, and eval to execute JavaScript in the app context.
When to Use It
- Automate routine vault edits and note creation from scripts
- Search vault content for terms and export results quickly
- Batch-create, update, or append notes using templates and content
- Develop or debug Obsidian plugins and themes from the CLI
- Perform UI checks or debugging with screenshots and DOM inspection
Quick Start
- Step 1: Ensure Obsidian is open and the target vault is active
- Step 2: Run a simple command, e.g., obsidian read file=\"My Note\" to verify connectivity
- Step 3: For development, reload a plugin with obsidian plugin:reload id=my-plugin and inspect the UI with obsidian dev:screenshot path=shot.png or obsidian dev:dom selector=\".workspace-leaf\"
Best Practices
- Target the correct vault with vault=<name> when multiple vaults exist
- Use file=<name> or path=<path> for precise edits instead of the active file
- Escape multiline content with \n and \t as needed
- Use --copy to export results to the clipboard and silent to avoid opening files
- Validate plugin changes by reloading with plugin:reload and checking dev:errors before continuing
Example Use Cases
- obsidian read file=\"My Note\"
- obsidian create name=\"New Note\" content=\"# Hello\" template=\"Template\" silent
- obsidian search query=\"search term\" limit=10
- obsidian plugin:reload id=my-plugin
- obsidian dev:dom selector=\".workspace-leaf\" text
