11 Commits

Author SHA1 Message Date
pablo-mano 7d20d45a71 Add skill version badge to README
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-04 00:44:22 +01:00
pablo-mano ec070a1371 Sync plugins/ mirror with updated SKILL.md (v1.3.0)
Brings the plugins/obsidian-cli mirror in line with the root skill:
updated description and improved reference pointer.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-04 00:41:49 +01:00
pablo-mano 1ab03980b9 Bump version to 1.3.0
Covers: description rewrite (vault-intent triggering), Cortex Code
platform support, invoking guidance in README, improved reference
pointer in SKILL.md, and eval/ directory.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-04 00:40:40 +01:00
pablo-mano d7d115781e Add skill invocation guidance to README
Document three ways to activate the skill (natural language, explicit
prefix, strict mode) and fix the inaccurate "auto-triggers" claim on
the marketplace install step.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-04 00:38:56 +01:00
pablo-mano a882e74591 Apply optimized description from run_loop eval; add v2 eval set
Description rewritten to emphasize vault action intent over CLI syntax,
with explicit "without this skill Claude has no vault access" framing.
Adds v2 eval set (20 queries built around natural-language vault requests).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-04 00:37:19 +01:00
pablo-mano de356e8396 Broaden skill description to trigger on vault intent, not just CLI mentions
The skill should activate whenever the user wants Claude to interact with
their Obsidian vault — not only when they explicitly mention the CLI or
terminal. Casual phrases like "add to my daily note" or "search my vault"
are now explicit triggers.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-04 00:18:28 +01:00
pablo-mano c7b35b314d Optimize skill description and add eval set
Replace the broad description with a sharper, action-oriented one that
emphasizes the terminal/script context as the trigger signal and explicitly
lists concrete subcommands. Add eval/ directory with 20 trigger eval queries
and the HTML reviewer used to generate them.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-04 00:10:04 +01:00
pablo-mano b116ad4abf Improve command-reference pointer in SKILL.md
Make the reference blockquote actionable: specify when to read it (specific
flags/formats/subcommands) rather than just announcing it exists.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-03 23:38:04 +01:00
pablo-mano 536320574b Revert version to 1.2.0; gotcha docs were documentation-only
The issue #1 gotcha documentation was a doc-only change and did not
warrant a version bump. Revert plugin.json from 1.3.0 → 1.2.0.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-03 23:19:08 +01:00
pablo-mano a5a0d10d35 Add Snowflake Cortex Code installation section to README
Documents three install options (remote /skill add, project-local, user-level)
plus verify and invoke examples, following the same structure as other platform sections.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-03 23:14:19 +01:00
pablo-mano 986ff986d2 Document three real-world gotchas in v1.3.0 (issue #1)
- property:set stores list values as strings (not YAML arrays)
- eval requires single-line JS; add temp-file workaround
- Multi-vault "Name" command may fail; document fallback

Added Tips 10-12 to SKILL.md, inline callouts to command-reference.md,
two new Troubleshooting rows, and version bump to 1.3.0.

Fixes #1

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-03 23:08:04 +01:00
9 changed files with 465 additions and 27 deletions
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"name": "obsidian-cli", "name": "obsidian-cli",
"description": "Interact with Obsidian vaults using the official Obsidian CLI (v1.12+). Read, create, append, search, and manage notes, daily notes, properties, tags, tasks, bookmarks, templates, themes, sync, plugins, and links — all from the terminal.", "description": "Interact with Obsidian vaults using the official Obsidian CLI (v1.12+). Read, create, append, search, and manage notes, daily notes, properties, tags, tasks, bookmarks, templates, themes, sync, plugins, and links — all from the terminal.",
"version": "1.2.0", "version": "1.3.0",
"author": { "author": {
"name": "pablo-mano" "name": "pablo-mano"
}, },
+70 -1
View File
@@ -2,6 +2,7 @@
A skill for AI coding agents that enables full control of [Obsidian](https://obsidian.md) vaults from the terminal using the official **Obsidian CLI** (v1.12+). A skill for AI coding agents that enables full control of [Obsidian](https://obsidian.md) vaults from the terminal using the official **Obsidian CLI** (v1.12+).
![Version](https://img.shields.io/badge/skill-v1.3.0-CC785C)
![Obsidian](https://img.shields.io/badge/Obsidian-v1.12%2B-7C3AED?logo=obsidian&logoColor=white) ![Obsidian](https://img.shields.io/badge/Obsidian-v1.12%2B-7C3AED?logo=obsidian&logoColor=white)
![Claude Code](https://img.shields.io/badge/Claude_Code-Plugin-D97757) ![Claude Code](https://img.shields.io/badge/Claude_Code-Plugin-D97757)
![Claude Code Plugin](https://img.shields.io/badge/Anthropic-Compatible-CC785C) ![Claude Code Plugin](https://img.shields.io/badge/Anthropic-Compatible-CC785C)
@@ -31,6 +32,20 @@ Covers **100+ commands** across all major areas:
--- ---
## Invoking the Skill
The skill activates automatically when your request clearly involves Obsidian vault operations. For casual phrasing, you may need to invoke it explicitly:
| Method | Example |
|---|---|
| **Natural language** (usually works) | *"add this to my daily note: …"*, *"search my vault for X"* |
| **Explicit prefix** (always works) | `$obsidian-cli append to today's daily note: "…"` |
| **Strict mode** (always active) | Enable in Claude Code settings so the skill is always loaded |
If Claude tries to answer a vault request without executing any commands, just say `use obsidian-cli` and it will retry with the skill active.
---
## Prerequisites ## Prerequisites
> Obsidian v1.12 is available to **all users** — no Early Access build or Catalyst license required. > Obsidian v1.12 is available to **all users** — no Early Access build or Catalyst license required.
@@ -60,7 +75,7 @@ Covers **100+ commands** across all major areas:
/plugin install obsidian-cli /plugin install obsidian-cli
``` ```
Done — the skill auto-triggers when you ask Claude to interact with Obsidian. Done — see [Invoking the Skill](#invoking-the-skill) above for how to activate it.
**Option B — Direct plugin load:** **Option B — Direct plugin load:**
@@ -107,6 +122,60 @@ Cursor picks it up automatically — no restart needed.
--- ---
### Cortex Code
**Option A — Remote install (recommended)**
In a Cortex Code session, run:
```
/skill add https://github.com/pablo-mano/Obsidian-CLI-skill.git
```
Cortex Code clones the repo and caches the skill. Use `/skill sync obsidian-cli` to pull
updates later.
**Option B — Project-local install**
```bash
mkdir -p .cortex/skills/obsidian-cli
curl -sSL https://raw.githubusercontent.com/pablo-mano/Obsidian-CLI-skill/main/skills/obsidian-cli/SKILL.md \
-o .cortex/skills/obsidian-cli/SKILL.md
```
Or clone the repo and copy:
```bash
git clone https://github.com/pablo-mano/Obsidian-CLI-skill.git /tmp/obsidian-cli-skill
cp -r /tmp/obsidian-cli-skill/skills/obsidian-cli .cortex/skills/
```
**Option C — User-level install**
```bash
mkdir -p ~/.snowflake/cortex/skills/obsidian-cli
cp skills/obsidian-cli/SKILL.md ~/.snowflake/cortex/skills/obsidian-cli/
```
**Verify**
```
/skill list
```
You should see `obsidian-cli` in the output.
**Invoke**
Prefix requests with `$obsidian-cli` or just describe what you want — Cortex Code activates
the skill automatically when the context matches:
```
$obsidian-cli append to today's daily note: "Reviewed Snowflake PR #42"
```
---
### GitHub Copilot (VS Code) ### GitHub Copilot (VS Code)
Copilot supports [custom instructions](https://docs.github.com/en/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot) via repository files: Copilot supports [custom instructions](https://docs.github.com/en/copilot/customizing-copilot/adding-custom-instructions-for-github-copilot) via repository files:
+219
View File
@@ -0,0 +1,219 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Eval Set Review - obsidian-cli v2</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Poppins:wght@500;600&family=Lora:wght@400;500&display=swap" rel="stylesheet">
<style>
* { box-sizing: border-box; margin: 0; padding: 0; }
body { font-family: 'Lora', Georgia, serif; background: #faf9f5; padding: 2rem; color: #141413; }
h1 { font-family: 'Poppins', sans-serif; margin-bottom: 0.5rem; font-size: 1.5rem; }
.description { color: #b0aea5; margin-bottom: 1.5rem; font-style: italic; max-width: 900px; }
.controls { margin-bottom: 1rem; display: flex; gap: 0.5rem; }
.btn { font-family: 'Poppins', sans-serif; padding: 0.5rem 1rem; border: none; border-radius: 6px; cursor: pointer; font-size: 0.875rem; font-weight: 500; }
.btn-add { background: #6a9bcc; color: white; }
.btn-add:hover { background: #5889b8; }
.btn-export { background: #d97757; color: white; }
.btn-export:hover { background: #c4613f; }
table { width: 100%; max-width: 1100px; border-collapse: collapse; background: white; border-radius: 6px; overflow: hidden; box-shadow: 0 1px 3px rgba(0,0,0,0.08); }
th { font-family: 'Poppins', sans-serif; background: #141413; color: #faf9f5; padding: 0.75rem 1rem; text-align: left; font-size: 0.875rem; }
td { padding: 0.75rem 1rem; border-bottom: 1px solid #e8e6dc; vertical-align: top; }
tr:nth-child(even) td { background: #faf9f5; }
tr:hover td { background: #f3f1ea; }
.section-header td { background: #e8e6dc; font-family: 'Poppins', sans-serif; font-weight: 500; font-size: 0.8rem; color: #141413; text-transform: uppercase; letter-spacing: 0.05em; }
.query-input { width: 100%; padding: 0.4rem; border: 1px solid #e8e6dc; border-radius: 4px; font-size: 0.875rem; font-family: 'Lora', Georgia, serif; resize: vertical; min-height: 60px; }
.query-input:focus { outline: none; border-color: #d97757; box-shadow: 0 0 0 2px rgba(217,119,87,0.15); }
.toggle { position: relative; display: inline-block; width: 44px; height: 24px; }
.toggle input { opacity: 0; width: 0; height: 0; }
.toggle .slider { position: absolute; inset: 0; background: #b0aea5; border-radius: 24px; cursor: pointer; transition: 0.2s; }
.toggle .slider::before { content: ""; position: absolute; width: 18px; height: 18px; left: 3px; bottom: 3px; background: white; border-radius: 50%; transition: 0.2s; }
.toggle input:checked + .slider { background: #d97757; }
.toggle input:checked + .slider::before { transform: translateX(20px); }
.btn-delete { background: #c44; color: white; padding: 0.3rem 0.6rem; border: none; border-radius: 4px; cursor: pointer; font-size: 0.75rem; font-family: 'Poppins', sans-serif; }
.btn-delete:hover { background: #a33; }
.summary { margin-top: 1rem; color: #b0aea5; font-size: 0.875rem; }
</style>
</head>
<body>
<h1>Eval Set Review: <span id="skill-name">obsidian-cli</span></h1>
<p class="description">Current description: <span id="skill-desc">Use this skill whenever the user wants Claude to interact with their Obsidian vault — reading notes, creating or appending content, searching, managing tasks, tags, properties, daily notes, bookmarks, templates, sync, plugins, or links. The underlying mechanism is the official Obsidian CLI (v1.12+), but trigger even when the user doesn't mention the CLI — phrases like "add this to my daily note", "search my vault", "create a note from template", or "what tasks do I have open?" all apply. Also trigger for explicit CLI usage: running obsidian subcommands from a shell, scripting or automating vault operations, scheduling via cron, debugging IPC/headless Linux setups, or building programmatic wrappers. Skip only for pure GUI questions (Obsidian settings navigation, theme/plugin installation via UI) or iCloud sync configuration that has nothing to do with vault content.</span></p>
<div class="controls">
<button class="btn btn-add" onclick="addRow()">+ Add Query</button>
<button class="btn btn-export" onclick="exportEvalSet()">Export Eval Set</button>
</div>
<table>
<thead>
<tr>
<th style="width:65%">Query</th>
<th style="width:18%">Should Trigger</th>
<th style="width:10%">Actions</th>
</tr>
</thead>
<tbody id="eval-body"></tbody>
</table>
<p class="summary" id="summary"></p>
<script>
const EVAL_DATA = [
{
"query": "add this to my daily note: 'reviewed the Q1 roadmap with sarah, she wants the mockups by friday'",
"should_trigger": true
},
{
"query": "search my vault for everything i've written about the Henderson project, i need to prep for a call",
"should_trigger": true
},
{
"query": "what open tasks do i have in obsidian? just the incomplete ones",
"should_trigger": true
},
{
"query": "create a new note from my meeting-notes template and call it 'Standup 2026-03-04'",
"should_trigger": true
},
{
"query": "append '- [ ] follow up with the design team about the nav bar' to my projects/mobile-redesign.md",
"should_trigger": true
},
{
"query": "how many notes are in my vault right now? also which ones have no links pointing to them?",
"should_trigger": true
},
{
"query": "read me today's daily note",
"should_trigger": true
},
{
"query": "set the status property on projects/q2-launch.md to 'in-review'",
"should_trigger": true
},
{
"query": "i want to write a script that pulls all notes tagged #meeting from the past week and summarizes them",
"should_trigger": true
},
{
"query": "move everything in my Inbox/ folder to Archive/2026/ and update the daily note with a log entry",
"should_trigger": true
},
{
"query": "how do i change the accent color in obsidian? i want something more muted than the default purple",
"should_trigger": false
},
{
"query": "i can't figure out how to enable community plugins in obsidian — the toggle is greyed out in safe mode",
"should_trigger": false
},
{
"query": "does obsidian have a built-in kanban view or do i need a plugin for that?",
"should_trigger": false
},
{
"query": "my icloud sync for obsidian keeps conflicting with files on my ipad — how do i resolve this without losing data?",
"should_trigger": false
},
{
"query": "how do i set up the obsidian git plugin to auto-commit my vault every hour?",
"should_trigger": false
},
{
"query": "i use notion for my notes but i'm thinking of switching to obsidian — what's the best way to export from notion and import into obsidian?",
"should_trigger": false
},
{
"query": "in the dataview plugin, how do i write a query that shows all notes with a due-date property before today?",
"should_trigger": false
},
{
"query": "i want to customize the obsidian theme with css — how do i target the sidebar background color specifically?",
"should_trigger": false
},
{
"query": "what's the keyboard shortcut to open the command palette in obsidian on mac?",
"should_trigger": false
},
{
"query": "i'm writing a python script to parse markdown files from my notes folder and extract all the headings into a CSV — what's the best library for this?",
"should_trigger": false
}
];
let evalItems = [...EVAL_DATA];
function render() {
const tbody = document.getElementById('eval-body');
tbody.innerHTML = '';
const sorted = evalItems
.map((item, origIdx) => ({ ...item, origIdx }))
.sort((a, b) => (b.should_trigger ? 1 : 0) - (a.should_trigger ? 1 : 0));
let lastGroup = null;
sorted.forEach(item => {
const group = item.should_trigger ? 'trigger' : 'no-trigger';
if (group !== lastGroup) {
const headerRow = document.createElement('tr');
headerRow.className = 'section-header';
headerRow.innerHTML = `<td colspan="3">${item.should_trigger ? 'Should Trigger' : 'Should NOT Trigger'}</td>`;
tbody.appendChild(headerRow);
lastGroup = group;
}
const idx = item.origIdx;
const tr = document.createElement('tr');
tr.innerHTML = `
<td><textarea class="query-input" onchange="updateQuery(${idx}, this.value)">${escapeHtml(item.query)}</textarea></td>
<td>
<label class="toggle">
<input type="checkbox" ${item.should_trigger ? 'checked' : ''} onchange="updateTrigger(${idx}, this.checked)">
<span class="slider"></span>
</label>
<span style="margin-left:8px;font-size:0.8rem;color:#b0aea5">${item.should_trigger ? 'Yes' : 'No'}</span>
</td>
<td><button class="btn-delete" onclick="deleteRow(${idx})">Delete</button></td>
`;
tbody.appendChild(tr);
});
updateSummary();
}
function escapeHtml(text) {
const div = document.createElement('div');
div.textContent = text;
return div.innerHTML;
}
function updateQuery(idx, value) { evalItems[idx].query = value; updateSummary(); }
function updateTrigger(idx, value) { evalItems[idx].should_trigger = value; render(); }
function deleteRow(idx) { evalItems.splice(idx, 1); render(); }
function addRow() {
evalItems.push({ query: '', should_trigger: true });
render();
const inputs = document.querySelectorAll('.query-input');
inputs[inputs.length - 1].focus();
}
function updateSummary() {
const trigger = evalItems.filter(i => i.should_trigger).length;
const noTrigger = evalItems.filter(i => !i.should_trigger).length;
document.getElementById('summary').textContent =
`${evalItems.length} queries total: ${trigger} should trigger, ${noTrigger} should not trigger`;
}
function exportEvalSet() {
const valid = evalItems.filter(i => i.query.trim() !== '');
const data = valid.map(i => ({ query: i.query.trim(), should_trigger: i.should_trigger }));
const blob = new Blob([JSON.stringify(data, null, 2)], { type: 'application/json' });
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = 'eval_set.json';
document.body.appendChild(a);
a.click();
document.body.removeChild(a);
URL.revokeObjectURL(url);
}
render();
</script>
</body>
</html>
+82
View File
@@ -0,0 +1,82 @@
[
{
"query": "add this to my daily note: 'reviewed the Q1 roadmap with sarah, she wants the mockups by friday'",
"should_trigger": true
},
{
"query": "search my vault for everything i've written about the Henderson project, i need to prep for a call",
"should_trigger": true
},
{
"query": "what open tasks do i have in obsidian? just the incomplete ones",
"should_trigger": true
},
{
"query": "create a new note from my meeting-notes template and call it 'Standup 2026-03-04'",
"should_trigger": true
},
{
"query": "append '- [ ] follow up with the design team about the nav bar' to my projects/mobile-redesign.md",
"should_trigger": true
},
{
"query": "how many notes are in my vault right now? also which ones have no links pointing to them?",
"should_trigger": true
},
{
"query": "read me today's daily note",
"should_trigger": true
},
{
"query": "set the status property on projects/q2-launch.md to 'in-review'",
"should_trigger": true
},
{
"query": "i want to write a script that pulls all notes tagged #meeting from the past week and summarizes them",
"should_trigger": true
},
{
"query": "move everything in my Inbox/ folder to Archive/2026/ and update the daily note with a log entry",
"should_trigger": true
},
{
"query": "how do i change the accent color in obsidian? i want something more muted than the default purple",
"should_trigger": false
},
{
"query": "i can't figure out how to enable community plugins in obsidian — the toggle is greyed out in safe mode",
"should_trigger": false
},
{
"query": "does obsidian have a built-in kanban view or do i need a plugin for that?",
"should_trigger": false
},
{
"query": "my icloud sync for obsidian keeps conflicting with files on my ipad — how do i resolve this without losing data?",
"should_trigger": false
},
{
"query": "how do i set up the obsidian git plugin to auto-commit my vault every hour?",
"should_trigger": false
},
{
"query": "i use notion for my notes but i'm thinking of switching to obsidian — what's the best way to export from notion and import into obsidian?",
"should_trigger": false
},
{
"query": "in the dataview plugin, how do i write a query that shows all notes with a due-date property before today?",
"should_trigger": false
},
{
"query": "i want to customize the obsidian theme with css — how do i target the sidebar background color specifically?",
"should_trigger": false
},
{
"query": "what's the keyboard shortcut to open the command palette in obsidian on mac?",
"should_trigger": false
},
{
"query": "i'm writing a python script to parse markdown files from my notes folder and extract all the headings into a CSV — what's the best library for this?",
"should_trigger": false
}
]
@@ -1,7 +1,7 @@
{ {
"name": "obsidian-cli", "name": "obsidian-cli",
"description": "Interact with Obsidian vaults using the official Obsidian CLI (v1.12+). Read, create, append, search, and manage notes, daily notes, properties, tags, tasks, bookmarks, templates, themes, sync, plugins, and links — all from the terminal.", "description": "Interact with Obsidian vaults using the official Obsidian CLI (v1.12+). Read, create, append, search, and manage notes, daily notes, properties, tags, tasks, bookmarks, templates, themes, sync, plugins, and links — all from the terminal.",
"version": "1.2.0", "version": "1.3.0",
"author": { "author": {
"name": "pablo-mano" "name": "pablo-mano"
}, },
@@ -1,24 +1,26 @@
--- ---
name: obsidian-cli name: obsidian-cli
description: > description: >
Interact with Obsidian vaults using the official Obsidian CLI (v1.12+). Use this skill whenever the user wants Claude to directly interact with their
Read, create, append, search, and manage notes, daily notes, properties, tags, Obsidian vault — reading a note or daily note, writing or appending content,
tasks, bookmarks, templates, themes, sync, plugins, and links — all from the terminal. searching vault contents, counting or listing notes, managing tasks, moving or
Use this skill whenever the user mentions Obsidian CLI, wants to automate Obsidian renaming files, finding orphaned notes or broken links. Without this skill, Claude
vault operations, manage notes programmatically, script daily note workflows, has no way to access vault data or execute vault operations. Treat any request that
query vault metadata, or integrate Obsidian with AI agents or automation pipelines. implies "go into my vault and do X" as a trigger — the user is asking Claude to act,
Also trigger when the user asks about controlling Obsidian from the command line, not to explain. Also trigger for vault automation, CLI scripting, or cron-based
building scripts around their knowledge base, or running headless Obsidian setups. workflows involving Obsidian. Skip for pure conceptual questions: how Obsidian's GUI
Even if the user just says "add something to my daily note" or "search my vault" works, navigating settings menus, theme or plugin installation via the UI, or general
in a CLI/scripting context, this skill applies. Dataview query syntax — anything where the user needs an explanation rather than
Claude performing a vault operation.
--- ---
# Obsidian CLI # Obsidian CLI
The official Obsidian CLI (released in v1.12, February 2026) lets you control every aspect of Obsidian from the terminal. It communicates with a running Obsidian desktop instance via IPC. The official Obsidian CLI (released in v1.12, February 2026) lets you control every aspect of Obsidian from the terminal. It communicates with a running Obsidian desktop instance via IPC.
> For the full command reference with all subcommands, flags and examples, read > Read `references/command-reference.md` when you need specific flags, output formats, or
> `references/command-reference.md` in this skill folder. > subcommands for any command group. It covers all 130+ commands with full parameter tables
> and has a table of contents at the top.
## Prerequisites ## Prerequisites
@@ -229,6 +231,16 @@ obsidian command id="dataview:dataview-force-refresh-views"
7. **`daily:prepend`** inserts content after frontmatter, not at byte 0. 7. **`daily:prepend`** inserts content after frontmatter, not at byte 0.
8. **Use `eval`** to run arbitrary JavaScript against the Obsidian API (`app.*`). 8. **Use `eval`** to run arbitrary JavaScript against the Obsidian API (`app.*`).
9. **`template:insert`** inserts into the currently active file in the Obsidian UI — it does not accept a `path=` parameter. If no file is open, it returns `Error: No active editor. Open a file first.` To create a file from a template via CLI, use `obsidian create path="..." template="..."` instead. 9. **`template:insert`** inserts into the currently active file in the Obsidian UI — it does not accept a `path=` parameter. If no file is open, it returns `Error: No active editor. Open a file first.` To create a file from a template via CLI, use `obsidian create path="..." template="..."` instead.
10. **`property:set` stores list values as strings** — `value="tag1, tag2"` writes a literal comma-separated string, not a YAML array. For proper array fields, edit the note's frontmatter directly (e.g. via `read` → modify → `create --force`) or use `eval` to call the Obsidian API.
11. **`eval` requires single-line JavaScript** — multiline JS passed inline fails with a token error. Write the script to a temp file instead:
```bash
cat > /tmp/obs.js << 'JS'
var files = app.vault.getMarkdownFiles();
files.length;
JS
obsidian eval code="$(cat /tmp/obs.js)"
```
12. **Multi-vault targeting may not work in all environments** — `obsidian "My Vault" command` can return `Error: Command "My Vault" not found` on some setups. If this happens, omit the vault name (CLI targets the most recently active vault) and switch vaults manually in the Obsidian UI.
## Troubleshooting ## Troubleshooting
@@ -240,3 +252,5 @@ obsidian command id="dataview:dataview-force-refresh-views"
| Wrong vault targeted | Multi-vault ambiguity | Pass vault name as first arg | | Wrong vault targeted | Multi-vault ambiguity | Pass vault name as first arg |
| IPC socket not found (Linux) | `PrivateTmp=true` in systemd | Set `PrivateTmp=false` | | IPC socket not found (Linux) | `PrivateTmp=true` in systemd | Set `PrivateTmp=false` |
| Snap confinement issues | Snap restricts IPC | Use `.deb` package instead | | Snap confinement issues | Snap restricts IPC | Use `.deb` package instead |
| Multi-vault `"Name" command` fails | Vault name matching issue | Omit vault name; target most recent vault |
| `property:set` list value is a string | CLI stores value as-is | Edit frontmatter directly or use `eval` |
@@ -196,6 +196,10 @@ obsidian property:set path="note.md" name="tags" value="[project, alpha]"
obsidian property:set path="note.md" name="date" value="2026-02-27" obsidian property:set path="note.md" name="date" value="2026-02-27"
``` ```
> **Note:** `property:set` always stores `value=` as a string. Passing `value="[project, alpha]"` writes
> the literal string `[project, alpha]`, not a YAML array. For true array-typed properties (e.g. `tags`),
> edit the note's frontmatter directly or use `eval` with the Obsidian API.
### Remove Property ### Remove Property
```bash ```bash
@@ -487,6 +491,17 @@ obsidian eval code="app.vault.getMarkdownFiles().map(f => f.path).join('\n')"
Executes arbitrary JavaScript in the Obsidian app context. Has access to the full Obsidian API (`app`, `app.vault`, `app.workspace`, `app.metadataCache`, etc.). Executes arbitrary JavaScript in the Obsidian app context. Has access to the full Obsidian API (`app`, `app.vault`, `app.workspace`, `app.metadataCache`, etc.).
> **Multiline scripts:** Passing multiline JavaScript inline fails with "Invalid or unexpected token".
> Write the code to a temp file and use command substitution instead:
>
> ```bash
> cat > /tmp/obs.js << 'JS'
> var files = app.vault.getMarkdownFiles();
> files.map(f => f.path).join('\n');
> JS
> obsidian eval code="$(cat /tmp/obs.js)"
> ```
### Console & Errors ### Console & Errors
```bash ```bash
@@ -611,6 +626,11 @@ obsidian "Archive" files total
If the vault name contains spaces, quote it. The vault name must match what's shown in `obsidian vaults`. If the vault name contains spaces, quote it. The vault name must match what's shown in `obsidian vaults`.
> **Compatibility note:** On some environments, `obsidian "My Vault" command` returns
> `Error: Command "My Vault" not found`. If this occurs, omit the vault name — the CLI will target
> the most recently active vault. Switch vaults in the Obsidian UI before running CLI commands
> when targeting a specific vault.
--- ---
## Headless / Server Setup (Linux) ## Headless / Server Setup (Linux)
+26 -12
View File
@@ -1,24 +1,26 @@
--- ---
name: obsidian-cli name: obsidian-cli
description: > description: >
Interact with Obsidian vaults using the official Obsidian CLI (v1.12+). Use this skill whenever the user wants Claude to directly interact with their
Read, create, append, search, and manage notes, daily notes, properties, tags, Obsidian vault — reading a note or daily note, writing or appending content,
tasks, bookmarks, templates, themes, sync, plugins, and links — all from the terminal. searching vault contents, counting or listing notes, managing tasks, moving or
Use this skill whenever the user mentions Obsidian CLI, wants to automate Obsidian renaming files, finding orphaned notes or broken links. Without this skill, Claude
vault operations, manage notes programmatically, script daily note workflows, has no way to access vault data or execute vault operations. Treat any request that
query vault metadata, or integrate Obsidian with AI agents or automation pipelines. implies "go into my vault and do X" as a trigger — the user is asking Claude to act,
Also trigger when the user asks about controlling Obsidian from the command line, not to explain. Also trigger for vault automation, CLI scripting, or cron-based
building scripts around their knowledge base, or running headless Obsidian setups. workflows involving Obsidian. Skip for pure conceptual questions: how Obsidian's GUI
Even if the user just says "add something to my daily note" or "search my vault" works, navigating settings menus, theme or plugin installation via the UI, or general
in a CLI/scripting context, this skill applies. Dataview query syntax — anything where the user needs an explanation rather than
Claude performing a vault operation.
--- ---
# Obsidian CLI # Obsidian CLI
The official Obsidian CLI (released in v1.12, February 2026) lets you control every aspect of Obsidian from the terminal. It communicates with a running Obsidian desktop instance via IPC. The official Obsidian CLI (released in v1.12, February 2026) lets you control every aspect of Obsidian from the terminal. It communicates with a running Obsidian desktop instance via IPC.
> For the full command reference with all subcommands, flags and examples, read > Read `references/command-reference.md` when you need specific flags, output formats, or
> `references/command-reference.md` in this skill folder. > subcommands for any command group. It covers all 130+ commands with full parameter tables
> and has a table of contents at the top.
## Prerequisites ## Prerequisites
@@ -229,6 +231,16 @@ obsidian command id="dataview:dataview-force-refresh-views"
7. **`daily:prepend`** inserts content after frontmatter, not at byte 0. 7. **`daily:prepend`** inserts content after frontmatter, not at byte 0.
8. **Use `eval`** to run arbitrary JavaScript against the Obsidian API (`app.*`). 8. **Use `eval`** to run arbitrary JavaScript against the Obsidian API (`app.*`).
9. **`template:insert`** inserts into the currently active file in the Obsidian UI — it does not accept a `path=` parameter. If no file is open, it returns `Error: No active editor. Open a file first.` To create a file from a template via CLI, use `obsidian create path="..." template="..."` instead. 9. **`template:insert`** inserts into the currently active file in the Obsidian UI — it does not accept a `path=` parameter. If no file is open, it returns `Error: No active editor. Open a file first.` To create a file from a template via CLI, use `obsidian create path="..." template="..."` instead.
10. **`property:set` stores list values as strings** — `value="tag1, tag2"` writes a literal comma-separated string, not a YAML array. For proper array fields, edit the note's frontmatter directly (e.g. via `read` → modify → `create --force`) or use `eval` to call the Obsidian API.
11. **`eval` requires single-line JavaScript** — multiline JS passed inline fails with a token error. Write the script to a temp file instead:
```bash
cat > /tmp/obs.js << 'JS'
var files = app.vault.getMarkdownFiles();
files.length;
JS
obsidian eval code="$(cat /tmp/obs.js)"
```
12. **Multi-vault targeting may not work in all environments** — `obsidian "My Vault" command` can return `Error: Command "My Vault" not found` on some setups. If this happens, omit the vault name (CLI targets the most recently active vault) and switch vaults manually in the Obsidian UI.
## Troubleshooting ## Troubleshooting
@@ -240,3 +252,5 @@ obsidian command id="dataview:dataview-force-refresh-views"
| Wrong vault targeted | Multi-vault ambiguity | Pass vault name as first arg | | Wrong vault targeted | Multi-vault ambiguity | Pass vault name as first arg |
| IPC socket not found (Linux) | `PrivateTmp=true` in systemd | Set `PrivateTmp=false` | | IPC socket not found (Linux) | `PrivateTmp=true` in systemd | Set `PrivateTmp=false` |
| Snap confinement issues | Snap restricts IPC | Use `.deb` package instead | | Snap confinement issues | Snap restricts IPC | Use `.deb` package instead |
| Multi-vault `"Name" command` fails | Vault name matching issue | Omit vault name; target most recent vault |
| `property:set` list value is a string | CLI stores value as-is | Edit frontmatter directly or use `eval` |
@@ -196,6 +196,10 @@ obsidian property:set path="note.md" name="tags" value="[project, alpha]"
obsidian property:set path="note.md" name="date" value="2026-02-27" obsidian property:set path="note.md" name="date" value="2026-02-27"
``` ```
> **Note:** `property:set` always stores `value=` as a string. Passing `value="[project, alpha]"` writes
> the literal string `[project, alpha]`, not a YAML array. For true array-typed properties (e.g. `tags`),
> edit the note's frontmatter directly or use `eval` with the Obsidian API.
### Remove Property ### Remove Property
```bash ```bash
@@ -487,6 +491,17 @@ obsidian eval code="app.vault.getMarkdownFiles().map(f => f.path).join('\n')"
Executes arbitrary JavaScript in the Obsidian app context. Has access to the full Obsidian API (`app`, `app.vault`, `app.workspace`, `app.metadataCache`, etc.). Executes arbitrary JavaScript in the Obsidian app context. Has access to the full Obsidian API (`app`, `app.vault`, `app.workspace`, `app.metadataCache`, etc.).
> **Multiline scripts:** Passing multiline JavaScript inline fails with "Invalid or unexpected token".
> Write the code to a temp file and use command substitution instead:
>
> ```bash
> cat > /tmp/obs.js << 'JS'
> var files = app.vault.getMarkdownFiles();
> files.map(f => f.path).join('\n');
> JS
> obsidian eval code="$(cat /tmp/obs.js)"
> ```
### Console & Errors ### Console & Errors
```bash ```bash
@@ -611,6 +626,11 @@ obsidian "Archive" files total
If the vault name contains spaces, quote it. The vault name must match what's shown in `obsidian vaults`. If the vault name contains spaces, quote it. The vault name must match what's shown in `obsidian vaults`.
> **Compatibility note:** On some environments, `obsidian "My Vault" command` returns
> `Error: Command "My Vault" not found`. If this occurs, omit the vault name — the CLI will target
> the most recently active vault. Switch vaults in the Obsidian UI before running CLI commands
> when targeting a specific vault.
--- ---
## Headless / Server Setup (Linux) ## Headless / Server Setup (Linux)