Obsidian Cli

1---2name: obsidian-cli3description: 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.4---5 6# Obsidian CLI7 8Use the `obsidian` CLI to interact with a running Obsidian instance. Requires Obsidian to be open.9 10## Command reference11 12Run `obsidian help` to see all available commands. This is always up to date. Full docs: https://help.obsidian.md/cli13 14## Syntax15 16**Parameters** take a value with `=`. Quote values with spaces:17 18```bash19obsidian create name="My Note" content="Hello world"20```21 22**Flags** are boolean switches with no value:23 24```bash25obsidian create name="My Note" silent overwrite26```27 28For multiline content use `\n` for newline and `\t` for tab.29 30## File targeting31 32Many commands accept `file` or `path` to target a file. Without either, the active file is used.33 34- `file=<name>` — resolves like a wikilink (name only, no path or extension needed)35- `path=<path>` — exact path from vault root, e.g. `folder/note.md`36 37## Vault targeting38 39Commands target the most recently focused vault by default. Use `vault=<name>` as the first parameter to target a specific vault:40 41```bash42obsidian vault="My Vault" search query="test"43```44 45## Common patterns46 47```bash48obsidian read file="My Note"49obsidian create name="New Note" content="# Hello" template="Template" silent50obsidian append file="My Note" content="New line"51obsidian search query="search term" limit=1052obsidian daily:read53obsidian daily:append content="- [ ] New task"54obsidian property:set name="status" value="done" file="My Note"55obsidian tasks daily todo56obsidian tags sort=count counts57obsidian backlinks file="My Note"58```59 60Use `--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.61 62## Plugin development63 64### Develop/test cycle65 66After making code changes to a plugin or theme, follow this workflow:67 681. **Reload** the plugin to pick up changes:69   ```bash70   obsidian plugin:reload id=my-plugin71   ```722. **Check for errors** — if errors appear, fix and repeat from step 1:73   ```bash74   obsidian dev:errors75   ```763. **Verify visually** with a screenshot or DOM inspection:77   ```bash78   obsidian dev:screenshot path=screenshot.png79   obsidian dev:dom selector=".workspace-leaf" text80   ```814. **Check console output** for warnings or unexpected logs:82   ```bash83   obsidian dev:console level=error84   ```85 86### Additional developer commands87 88Run JavaScript in the app context:89 90```bash91obsidian eval code="app.vault.getFiles().length"92```93 94Inspect CSS values:95 96```bash97obsidian dev:css selector=".workspace-leaf" prop=background-color98```99 100Toggle mobile emulation:101 102```bash103obsidian dev:mobile on104```105 106Run `obsidian help` to see additional developer commands including CDP and debugger controls.