obsidian-skills README

The project's README from github.com/obsidianmd/obsidian-skills. As one markdown file: README.md.

Agent Skills for use with Obsidian.

These skills follow the Agent Skills specification so they can be used by any skills-compatible agent, including Claude Code, Codex, and Open Code.

Installation

Claude Code marketplace

From terminal:

claude plugin marketplace add obsidianmd/obsidian-skills
claude plugin install obsidian@obsidian-skills

From within a Claude Code session:

/plugin marketplace add obsidianmd/obsidian-skills
/plugin install obsidian@obsidian-skills

To get new skills later, run claude plugin update obsidian@obsidian-skills.

Codex marketplace

codex plugin marketplace add obsidianmd/obsidian-skills

Then install Obsidian from the plugin directory in Codex or the ChatGPT desktop app.

Cursor

Install Obsidian from the Cursor Marketplace.

npx skills

npx skills add https://github.com/obsidianmd/obsidian-skills

To use ssh instead, if you have a GitHub SSH key set up:

npx skills add [email protected]:obsidianmd/obsidian-skills.git

Gemini CLI

gemini extensions install https://github.com/obsidianmd/obsidian-skills

Manually

Claude Code

Copy the plugins/obsidian/skills/ directory to .claude/skills/ in the root of your Obsidian vault (or whichever folder you're using with Claude Code). See more in the official Claude Skills documentation.

Codex

Copy the plugins/obsidian/skills/ directory into your Codex skills path (typically ~/.agents/skills). See the Agent Skills specification for the standard skill format.

OpenCode

Clone the entire repo into the OpenCode skills directory (~/.opencode/skills/):

git clone https://github.com/obsidianmd/obsidian-skills.git ~/.opencode/skills/obsidian-skills

Do not copy only the inner skills/ folder — clone the full repo so the directory structure is ~/.opencode/skills/obsidian-skills/plugins/obsidian/skills/<skill-name>/SKILL.md.

OpenCode auto-discovers all SKILL.md files under ~/.opencode/skills/. No changes to opencode.json or any config file are needed. Skills become available after restarting OpenCode.

Release maintenance

Update the plugin version in every manifest with:

./scripts/bump.sh patch

The script also accepts major, minor, or an explicit version like 1.1.0.

Gemini CLI installs from the latest GitHub release, so publish a release for each version, tagged with the version number. The Gemini release archive workflow then attaches obsidian-gemini.tar.gz, which has real copies of the skills. Don't attach other files to a release, because Gemini CLI only picks a file when there's exactly one; otherwise it falls back to the source archive, which has no Gemini manifest. To build the archive locally, run ./scripts/package-gemini.sh.

Skills

Skill Description
obsidian-markdown Create and edit Obsidian Flavored Markdown (.md) with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax
obsidian-bases Create and edit Obsidian Bases (.base) with views, filters, formulas, and summaries
json-canvas Create and edit JSON Canvas files (.canvas) with nodes, edges, groups, and connections
obsidian-cli Interact with Obsidian vaults via the Obsidian CLI including plugin and theme development
obsidian-headless Sync and publish vaults from the command line with Obsidian Headless, without the desktop app
defuddle Extract clean markdown from web pages using Defuddle, removing clutter to save tokens
knap Render Markdown templates from JSON or CSV data using Knap, including batch file generation

obsidian-skills (obsidianmd/obsidian-skills)

Searching Database…

What is this?This is a set of Agent Skills for Obsidian that teaches AI coding agents (like Claude Code, Codex, and OpenCode) how to work with Obsidian's Markdown, Bases, and JSON Canvas files, plus the Obsidian CLI.
Is this an Obsidian plugin or something for my coding agent?It is not an Obsidian plugin. It's a collection of SKILL.md files that live inside your coding agent's skills folder (such as .claude, ~/.codex/skills, or ~/.opencode/skills) and give the agent domain knowledge about Obsidian's file formats.
How do I install these skills?You can install from the Agent Skills marketplace, run 'npx skills', or copy files manually — for Claude Code add the repo contents to a .claude folder in your vault root, for Codex copy skills/ into ~/.codex/skills, and for OpenCode clone the whole repo into ~/.opencode/skills/obsidian-skills.
Which coding agents can use these skills?Any agent that supports the Agent Skills specification; the README specifically names Claude Code, Codex, and OpenCode as supported.
Any install pitfalls I should watch for?For OpenCode you must clone the entire repository rather than just the inner skills/ folder, otherwise the SKILL.md files won't end up at the path OpenCode expects.
What skills are actually included?Five skills: obsidian-markdown for Obsidian Flavored Markdown syntax, obsidian-bases for .base files (views, filters, formulas), json-canvas for .canvas files, obsidian-cli for vault/plugin/theme management via the CLI, and defuddle for extracting clean markdown from web pages.
What does the json-canvas skill do?It teaches the agent to create and edit JSON Canvas (.canvas) files, including nodes, edges, groups, and connections.
What is the defuddle skill useful for?It strips clutter from web pages so the agent can pull out clean markdown, which saves tokens when feeding web content into an LLM.
Can I use these skills outside of Obsidian's own plugin system?Yes — since they follow the open Agent Skills specification, they work with any compatible coding agent, not just inside Obsidian itself.
Creator
obsidianmd
Size
0.2 MB
Stars
53.1K
Age
10mo
Commits · 90 Days