From e780c83ef32b1c9494f8a8c66972b3e1d10a1d77 Mon Sep 17 00:00:00 2001 From: pablo-mano Date: Fri, 27 Feb 2026 20:48:27 +0100 Subject: [PATCH] Add Claude Code plugin manifest; update for Obsidian v1.12 public release MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add plugin.json for Claude Code plugin system compatibility - Remove Catalyst License and Early Access/Insider requirements — Obsidian v1.12 is now available to all users - Update README: Claude Code plugin install instructions with /plugin command, manual ZIP install option, and corrected prerequisites - Fix Windows platform note (remove insider Discord channel reference) Co-Authored-By: Claude Sonnet 4.6 --- README.md | 33 ++++++++++++++++++++------------- SKILL.md | 5 ++--- plugin.json | 8 ++++++++ 3 files changed, 30 insertions(+), 16 deletions(-) create mode 100644 plugin.json diff --git a/README.md b/README.md index 1d776e8..6cd1778 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ 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+). ![Obsidian](https://img.shields.io/badge/Obsidian-v1.12%2B-7C3AED?logo=obsidian&logoColor=white) -![Claude Code](https://img.shields.io/badge/Claude_Code-Skill-D97757) +![Claude Code](https://img.shields.io/badge/Claude_Code-Plugin-D97757) +![Claude Code Plugin](https://img.shields.io/badge/Anthropic-Compatible-CC785C) --- @@ -32,34 +33,40 @@ Covers **100+ commands** across all major areas: ## Prerequisites +> Obsidian v1.12 is available to **all users** — no Early Access build or Catalyst license required. + | Requirement | Details | |---|---| -| **Obsidian Desktop** | v1.12.0+ (Insider / Early Access build) | +| **Obsidian Desktop** | v1.12.0+ | | **CLI enabled** | Settings → Command line interface → Toggle ON | | **Obsidian running** | The desktop app must be running — the CLI communicates over IPC | -| **Catalyst License** | $25 one-time (Early Access); planned to be free for all users later | ### Platform notes - **macOS / Linux** — the `obsidian` binary is added to PATH automatically when you enable CLI in settings. -- **Windows** — requires an `Obsidian.com` redirector file placed alongside `Obsidian.exe` (available in the `#insider-desktop-release` channel on Obsidian Discord). Must run from a **normal-privilege terminal** — admin terminals produce silent failures. +- **Windows** — requires an `Obsidian.com` redirector file placed alongside `Obsidian.exe`. Must run from a **normal-privilege terminal** — admin terminals produce silent failures. - **Headless Linux** — use the `.deb` package (not snap). Run under `xvfb` and prefix commands with `DISPLAY=:5`. Set `PrivateTmp=false` if running as a systemd service. --- ## Installation -### Claude Code — Skills Plugin (native) +### Claude Code — Plugin (native) -1. **Clone or download** this repository: - ```bash - git clone https://github.com/pablo-mano/Obsidian-CLI-skill.git +Install directly from GitHub using the Claude Code plugin system: + +1. Open Claude Code and run: ``` -2. **Open Claude Code** and navigate to the **Skills plugin** settings. -3. **Import skill** — point to the cloned folder (or a `.zip` of it). -4. Done. The skill auto-triggers whenever you ask Claude to interact with Obsidian, automate vault operations, manage daily notes, search your vault, etc. + /plugin marketplace add https://github.com/pablo-mano/Obsidian-CLI-skill + ``` +2. Install the `obsidian-cli` skill from the plugin list. +3. Done — the skill auto-triggers when you ask Claude to interact with Obsidian, automate vault operations, manage daily notes, search your vault, etc. -> The skill uses Obsidian CLI syntax and patterns from `SKILL.md` and the full command reference in `references/command-reference.md`. +**Alternative — manual install:** +1. Download `obsidian-cli-skill-v1.0.0.zip` from the [Releases](https://github.com/pablo-mano/Obsidian-CLI-skill/releases) page. +2. Open Claude Code → Skills plugin settings → Import → select the `.zip`. + +> The `plugin.json` manifest at the repo root makes this repository directly compatible with Claude Code's plugin system. --- @@ -164,4 +171,4 @@ See [`references/command-reference.md`](references/command-reference.md) for the ## License -This skill is provided as-is for use with the Obsidian CLI. Obsidian itself requires a [Catalyst license](https://obsidian.md/pricing) for Early Access builds. +This skill is provided as-is for use with the Obsidian CLI. Obsidian v1.12+ is free for all users. diff --git a/SKILL.md b/SKILL.md index b6c9951..108c198 100644 --- a/SKILL.md +++ b/SKILL.md @@ -24,15 +24,14 @@ The official Obsidian CLI (released in v1.12, February 2026) lets you control ev | Requirement | Details | |---|---| -| Obsidian Desktop | **v1.12.0+** (Early Access / Insider builds) | +| Obsidian Desktop | **v1.12.0+** | | CLI enabled | Settings → Command line interface → Toggle ON | | Obsidian running | The desktop app **must be running** for CLI to work (IPC) | -| Catalyst License | $25 one-time (Early Access); planned free for all users later | ### Platform Notes - **macOS / Linux**: The `obsidian` binary is registered in PATH automatically when you enable CLI in settings. -- **Windows**: Requires an `Obsidian.com` redirector file placed alongside `Obsidian.exe` (get it from the `#insider-desktop-release` channel on Obsidian Discord). **Must run with normal user privileges** — admin terminals produce silent failures. +- **Windows**: Requires an `Obsidian.com` redirector file placed alongside `Obsidian.exe`. **Must run with normal user privileges** — admin terminals produce silent failures. - **Headless Linux**: Use the `.deb` package (not snap). Run under `xvfb`. Prefix commands with `DISPLAY=:5` (or your xvfb display number). Ensure `PrivateTmp=false` if running as a service. ## Syntax diff --git a/plugin.json b/plugin.json new file mode 100644 index 0000000..b87764b --- /dev/null +++ b/plugin.json @@ -0,0 +1,8 @@ +{ + "name": "obsidian-cli", + "version": "1.0.0", + "description": "Interact with Obsidian vaults using the official Obsidian CLI (v1.12+). Read, create, search, and manage notes, daily notes, properties, tags, tasks, bookmarks, templates, sync, plugins, and links — all from the terminal.", + "author": "pablo-mano", + "repository": "https://github.com/pablo-mano/Obsidian-CLI-skill", + "skills": ["."] +}