obsidian-cli

1# Obsidian CLI
2 
3Use the `obsidian` CLI to interact with a running Obsidian instance. Requires Obsidian to be open.
4 
5## Command reference
6 
7Run `obsidian help` to see all available commands. This is always up to date. Full docs: https://help.obsidian.md/cli
8 
9## Syntax
10 
11**Parameters** take a value with `=`. Quote values with spaces:
12 
13```bash
14obsidian create name="My Note" content="Hello world"
15```
16 
17**Flags** are boolean switches with no value:
18 
19```bash
20obsidian create name="My Note" silent overwrite
21```
22 
23For multiline content use `\n` for newline and `\t` for tab.
24 
25## File targeting
26 
27Many commands accept `file` or `path` to target a file. Without either, the active file is used.
28 
29- `file=<name>` — resolves like a wikilink (name only, no path or extension needed)
30- `path=<path>` — exact path from vault root, e.g. `folder/note.md`
31 
32## Vault targeting
33 
34Commands target the most recently focused vault by default. Use `vault=<name>` as the first parameter to target a specific vault:
35 
36```bash
37obsidian vault="My Vault" search query="test"
38```
39 
40## Common patterns
41 
42```bash
43obsidian read file="My Note"
44obsidian create name="New Note" content="# Hello" template="Template" silent
45obsidian append file="My Note" content="New line"
46obsidian search query="search term" limit=10
47obsidian daily:read
48obsidian daily:append content="- [ ] New task"
49obsidian property:set name="status" value="done" file="My Note"
50obsidian tasks daily todo
51obsidian tags sort=count counts
52…