obsidian-cli
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
Install / Use
npx skills add obsidianmd/obsidian-skills --skill obsidian-cliInstalls into whichever agent you are using.
SKILL.md
Installable skill definition
Quality Score
Category
Customer SupportSupported Platforms
Tags
Our assessment of obsidian-cli
obsidian-cli scores 99/100 on our quality scale, 7th of 319 Customer Support skills we index (top 3%).
Its SKILL.md is 6.2 KB long, well organised into 11 sections with 8 code examples: a thorough specification that gives an agent plenty to work with.
With 52,232 GitHub stars, it is one of the more widely adopted skills in the catalogue.
Maintenance, license and trust
- The repository was last updated 5 days ago, so obsidian-cli is actively maintained.
- It is released under the MIT license, a permissive license that allows use, modification and commercial use with attribution.
- Its trust signals score 100/100, with no cautions. These come from repository metadata, not a code audit — read the skill file before letting an agent act on it.
Safety scan
No issues foundOur scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful.
AI review by kimi-k2.7-code on 2026-11-14. Automated pattern scan on 2026-11-14. It catches known dangerous patterns, not every risk — read a skill before letting an agent act on it.
obsidian-cli compared with similar skills
All 4 of these similar skills score higher than obsidian-cli; compare them before choosing.
| Skill | Score | Stars | Updated | Format |
|---|---|---|---|---|
| obsidian-cli (this skill)by obsidianmd | 99 | 52.2k | 5d ago | SKILL.md |
| Claude-Code-Game-Studiosby Donchitos | 100 | 39.7k | 7d ago | CLAUDE.md |
| x402by browser-use | 100 | 121.0k | 3d ago | SKILL.md |
| algorithmic-artby anthropics | 100 | 177.9k | 55d ago | SKILL.md |
| pptxby anthropics | 100 | 177.9k | 55d ago | SKILL.md |
Frequently asked questions
- How do I install obsidian-cli?
- Run
npx skills add obsidianmd/obsidian-skills --skill obsidian-cli. The install tabs above show the steps for each supported agent. - Which AI agents does obsidian-cli work with?
- It is written for Universal, as a SKILL.md file. Other agents that read the same format can often use it too.
- Is obsidian-cli safe to use?
- Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful. It is MIT-licensed and scores 100/100 on trust signals. Skills are instructions an agent will follow, so read the file before installing it and do not approve commands you do not understand.
- Is obsidian-cli still maintained?
- The repository was last updated 5 days ago, so obsidian-cli is actively maintained.
Skill content
View source on GitHubname: obsidian-cli description: 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.
Obsidian CLI
Use the obsidian CLI to interact with a running Obsidian instance. Requires Obsidian to be open.
Before using the CLI
Run 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.
On 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.
The CLI exits with status 0 even when a command fails, so read its output before reporting that a command succeeded.
Quote parameters for the current shell, and pass note text as literal argument data, never as executable shell syntax.
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" open overwrite
Use overwrite only when replacing an existing file is intended.
Opening is opt-in: pass open to open the file, and add newtab to open it in a new tab. There is no silent flag.
In content=, \n becomes a newline and \t a tab. Every \n and \t is converted and there's no escape, so text such as the LaTeX \theta or the path C:\notes is corrupted. Write content that contains backslashes, or is longer than about 4 KB, directly to the note's file instead.
A dot in a file name is read as the start of an extension. When a name contains a dot, include the extension: create name="Meeting 2026.11.06.md", rename name="v1.2 notes.md", move to="Archive 2026.10/Note.md".
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 needed)..mdis optional; other file types need their extension, e.g.file="Projects.base". Aliases don't resolve.path=<path>— exact path from vault root, e.g.folder/note.md
Vault targeting
Without vault=, commands target the vault that contains the current directory, then the most recently focused vault. vault=<name> only works as the first parameter; anywhere else it's ignored:
obsidian vault="My Vault" search query="test"
Use vault= when the user has selected a vault. If the target is unclear and the user has several vaults, ask which one before changing files.
Common patterns
obsidian read file="My Note"
obsidian create name="New Note" template="Template" # a template replaces content=
obsidian create name="New Note" content="# Hello" open # also open in Obsidian
obsidian append file="My Note" content="New line"
obsidian rename path="folder/note.md" name="New name"
obsidian move path="folder/note.md" to="archive/"
obsidian delete path="folder/note.md"
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 rename and move, not filesystem mv or obsidian eval, so Obsidian can update links to the file. If other notes link to it and Settings → Files and links → Automatically update internal links is off, Obsidian asks in a dialog and the command waits until someone answers. delete moves the file to the trash; don't pass permanent unless the user asks for it. Prefer create and append over eval for writing note bodies.
Use total on list commands to get a count.
Output options placement: --copy, --json, --md, --tsv, and --csv only work after the command name. Putting them before the command (or before vault=) fails — often as Command "--copy" not found — because the first token is treated as the command. Prefer vault= first when used; put double-dash options last:
obsidian tasks todo total --copy
obsidian vault="My Vault" search query="TODO" --copy
obsidian tasks todo format=json # many list commands also accept format=
# Wrong: obsidian --copy vault="My Vault" tasks todo
Plugin development
Develop/test cycle
Turn on console capture once with obsidian dev:debug on, so messages from the reload are kept. 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 obsidian dev:dom selector=".workspace-leaf" text - Check console output for warnings or unexpected logs:
obsidian dev:console level=error
dev:screenshot saves to a temporary file and prints its path. A relative path= saves inside the vault.
Additional developer commands
Run JavaScript in the app context (prefer dedicated commands like rename, move, create, and append for vault mutations):
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.
Related Skills
Claude-Code-Game-Studios
39.7kTurn Claude Code into a full game dev studio — 49 AI agents, 72 workflow skills, and a complete coordination system mirroring real studio hierarchy.
x402
121.0kSet up Browser Use Cloud payments with x402 — pay per request from a crypto wallet (USDC on Base mainnet), no signup or API key.
algorithmic-art
177.9kCreating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems.
pptx
177.9kUse this skill any time a .pptx or .potx file is involved in any way — as input, output, or both. This includes: creating slide decks, pitch decks, or presentations; reading, parsing, or extracting text from any .pptx or .potx file (even if the extracted content will be used elsewhere, like in an em…
Languages
Trust signals
From repository metadata: license, adoption, age and documentation. Not a code audit — see the Safety scan above for what the skill file itself contains.
