Manage Obsidian notes from the command line: read, create, search, update properties, and review tasks. Also supports plugin and theme development through reload commands, error checks, screenshots, and inspection of page elements.
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.
Review the instructions the agent will receive before you install.
Use the obsidian CLI to interact with a running Obsidian instance. Requires Obsidian to be open.
Run obsidian help to see all available commands. This is always up to date. Full docs: https://help.obsidian.md/cli
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.
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.mdCommands 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"
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.
After making code changes to a plugin or theme, follow this workflow:
obsidian plugin:reload id=my-plugin
obsidian dev:errors
obsidian dev:screenshot path=screenshot.png
obsidian dev:dom selector=".workspace-leaf" text
obsidian dev:console level=error
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.
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Extract readable content from web pages with Defuddle CLI, removing navigation, ads, and other clutter. Save the result as Markdown, or retrieve individual details such as the page title, description, and domain.
Create and edit .canvas files for visual planning in tools such as Obsidian. Arrange text, files, and links into mind maps or flowcharts, connect related items, and check that the file structure remains valid.
Turn JSON or CSV data into Markdown notes using Knap templates. Apply formatting rules and conditional sections, generate files in batches, or shape web content extracted by Defuddle into a consistent note format.
Create and edit Obsidian Bases files to organize notes into tables, cards, and lists. Filter notes by tags or properties, calculate values such as days until a deadline, and configure grouping and summaries.
Create and edit Obsidian Markdown notes with links between notes, embedded images and PDFs, highlighted callout boxes, tags, and properties. Use Obsidian-specific formatting to connect related material and organize information within notes.