obsidian-cli

1# Obsidian CLI
2 
3Use the `obsidian` CLI to interact with a running Obsidian instance. Requires Obsidian to be open.
4 
5## Before using the CLI
6 
7Run `obsidian help` to check availability. If the command is missing, explain how to turn on the CLI using https://help.obsidian.md/cli. The `obsidian` command ships with the Obsidian installer; don't install the unrelated npm package `obsidian-cli`. If it can't find Obsidian, ask the user to open the desktop app, then retry. In a sandboxed shell the same message can mean the sandbox blocked the CLI's local socket.
8 
9On WSL, run `Obsidian.com` from the Windows install folder, not `Obsidian.exe`. `Obsidian.com` is the console wrapper that prints the output; `Obsidian.exe` exits without printing anything.
10 
11The CLI exits with status 0 even when a command fails, so read its output before reporting that a command succeeded.
12 
13Quote parameters for the current shell, and pass note text as literal argument data, never as executable shell syntax.
14 
15## Command reference
16 
17Run `obsidian help` to see all available commands. This is always up to date. Full docs: https://help.obsidian.md/cli
18 
19## Syntax
20 
21**Parameters** take a value with `=`. Quote values with spaces:
22 
23```bash
24obsidian create name="My Note" content="Hello world"
25```
26 
27**Flags** are boolean switches with no value:
28 
29```bash
30obsidian create name="My Note" open overwrite
31```
32 
33Use `overwrite` only when replacing an existing file is intended.
34…