# Obsidian Cli > > - **Type:** Skill - **Install:** `agentstack add skill-jackal092927-obsidian-official-cli-skills-obsidian-cli` - **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior - **Seller:** [jackal092927](https://agentstack.voostack.com/s/jackal092927) - **Installs:** 0 - **Category:** [Productivity](https://agentstack.voostack.com/c/productivity) - **Latest version:** 0.1.0 - **License:** MIT - **Upstream author:** [jackal092927](https://github.com/jackal092927) - **Source:** https://github.com/jackal092927/obsidian-official-cli-skills/tree/main/plugins/obsidian-cli/skills/obsidian-cli ## Install ```sh agentstack add skill-jackal092927-obsidian-official-cli-skills-obsidian-cli ``` Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent. ## About # Obsidian CLI — Agent Reference ## When to Use CLI vs File Tools **Use CLI** when you need Obsidian's index or app features: search, backlinks, links, tags, tasks, properties, bases, templates, outline, orphans, unresolved links **Use file tools** (Read/Write/Edit/Grep/Glob) for: simple file read/write, bulk text replacement, grep across files — no app dependency Rule of thumb: if Obsidian's index adds value, use CLI. If it's plain text manipulation, use file tools. ## Syntax Basics ``` obsidian [param=value ...] [flag ...] ``` - **Vault targeting**: `vault="My Vault"` as first param, or run from inside vault dir - **File targeting**: `path=exact/path.md` (vault-relative) vs `file=name` (link-style resolution) - **Params**: `key=value` — quote values with spaces: `name="My Note"` - **Flags**: boolean switches, no `=` — e.g. `silent`, `overwrite`, `counts`, `total` - **Multiline**: `\n` for newline, `\t` for tab in content strings - **Structured output**: `format=json` (search, base:query), `format=tsv` (properties, tags) - **Clipboard**: append `--copy` to copy output ## Key Commands ### Read & Write ```sh obsidian read path= # read file content obsidian append path= content="" # append to file obsidian prepend path= content="" # prepend after frontmatter obsidian create name= content="" silent # create file (safe — won't overwrite) obsidian create name= template= overwrite silent # create from template obsidian move path= to= # move/rename file obsidian delete path= # move to system trash (safe) ``` Gotchas: - `create` without `silent` opens the file in Obsidian's UI — always add `silent` during agent operations. - `create` doesn't auto-create directories — use `mkdir -p` via Bash first if the parent folder doesn't exist. - `create` with `template=` may place the file in the template's configured folder, ignoring `path=`. Verify the actual path with `search` or `files` after creation. ### Daily Notes ```sh obsidian daily # open today's daily note obsidian daily:read # read daily note content obsidian daily:append content="" # append to daily note obsidian daily:prepend content="" # prepend to daily note ``` ### Properties (Frontmatter) ```sh obsidian property:set name= value= path= # set property obsidian property:set name= value= type= path= # set with explicit type obsidian property:read name= path= # read one property obsidian property:remove name= path= # remove property obsidian properties path= # list all properties obsidian properties path= format=tsv # list as TSV (key\tvalue) ``` ### Search ```sh obsidian search query="" # search vault (file paths) obsidian search query="" path= limit=10 # scoped search obsidian search query="" format=json # JSON array of paths obsidian search query="" format=json matches # structured JSON with line numbers (preferred) obsidian search query="" matches # text format with matching lines ``` Tip: `format=json matches` returns `[{"file":"path","matches":[{"line":N,"text":"..."}]}]` — use this for programmatic search. ### Tags & Tasks ```sh obsidian tags all counts # list ALL vault tags with counts obsidian tags all counts sort=count # sorted by frequency obsidian tag name= # files with specific tag obsidian tasks all todo # vault-wide open tasks obsidian tasks all done # vault-wide completed tasks obsidian tasks daily # tasks from daily note obsidian tasks path= # tasks in file/folder obsidian task ref=":" toggle # toggle task status obsidian task ref=":" done # mark done ``` Note: `tags` without `all` lists tags for the active/specified file only. Note: `tasks` without a scope (`all`, `daily`, `path=`) defaults to the active file — use `tasks all` for vault-wide results. ### Links & Graph ```sh obsidian backlinks path= # incoming links to file obsidian backlinks path= counts # with link counts obsidian links path= # outgoing links from file obsidian unresolved # broken/unresolved links obsidian orphans # files with no incoming links obsidian deadends # files with no outgoing links ``` ### Structure ```sh obsidian files folder= ext=md # list files in folder obsidian folders # list all folders obsidian outline path= # heading structure of file ``` ### Bases ```sh obsidian bases # list .base files obsidian base:query path= format=json # query a base obsidian base:query path= view= format=json # query specific view ``` ### Templates ```sh obsidian templates # list available templates obsidian template:read name= # read template source obsidian template:read name= resolve # render with variables filled ``` ## Safety Rules **Never run without explicit user request:** - `eval` — arbitrary code execution - `delete permanent` — bypasses trash - `plugin:install` / `plugin:uninstall` — modifies plugin state - `dev:cdp` — Chrome DevTools protocol access **Prefer safe patterns:** - Use `append` / `prepend` over full file overwrite - `create` without `overwrite` flag is safe (won't replace existing files) - Confirm with user before bulk property changes, file moves, or deletes ## Diagnostics ```sh obsidian vault # confirm CLI connection — returns vault name, path, file count obsidian version # show CLI version (e.g. "1.12.1 (installer 1.11.4)") ``` ## Error Handling | Symptom | Likely cause | Action | |---------|-------------|--------| | `obsidian version` fails | CLI not installed or not on PATH | Fall back to file tools | | Command hangs or times out | Obsidian app not running | Start Obsidian or use file tools | | "Unknown command" | CLI version too old | Run `obsidian help` to check available commands | | Empty results from search/tags | Vault index not ready | Wait a moment, retry, or use Grep as fallback | **General fallback**: if CLI is unavailable, use Read/Write/Edit/Grep/Glob for file operations. The CLI requires the Obsidian desktop app to be running. ## Source & license This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code. - **Author:** [jackal092927](https://github.com/jackal092927) - **Source:** [jackal092927/obsidian-official-cli-skills](https://github.com/jackal092927/obsidian-official-cli-skills) - **License:** MIT Install and usage instructions live in the source repository linked above. ## Pricing - **Free** — Free ## Security capabilities Automated source analysis of v0.1.0 — what this tool can access: - **Network access:** no - **Filesystem access:** no - **Shell / process execution:** no - **Environment & secrets:** no - **Dynamic code execution:** no *"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.* ## Versions - **0.1.0** — security scan: passed — Imported from the upstream source. ## Links - Listing page: https://agentstack.voostack.com/l/skill-jackal092927-obsidian-official-cli-skills-obsidian-cli - Seller: https://agentstack.voostack.com/s/jackal092927 - Browse the marketplace: https://agentstack.voostack.com/browse --- Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.