obsidian-skills README

项目的 README,来自 github.com/obsidianmd/obsidian-skills。合并为一个 markdown 文件: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)

正在搜索数据库…

这是什么?这是一套面向 Obsidian 的智能体技能(Agent Skills),用来教 AI 编程智能体(如 Claude Code、Codex 和 OpenCode)如何处理 Obsidian 的 Markdown、Bases 和 JSON Canvas 文件,以及 Obsidian 命令行工具。
这是 Obsidian 插件,还是给编程智能体用的东西?它不是 Obsidian 插件。它是一组 SKILL.md 文件,放在编程智能体的技能文件夹中(例如 .claude、~/.codex/skills 或 ~/.opencode/skills),为智能体提供关于 Obsidian 文件格式的专业知识。
我该如何安装这些技能?你可以从 Agent Skills 市场安装,运行 'npx skills',或手动复制文件:Claude Code 用户把仓库内容添加到库根目录下的 .claude 文件夹;Codex 用户把 skills/ 复制到 ~/.codex/skills;OpenCode 用户则把整个仓库克隆到 ~/.opencode/skills/obsidian-skills。
哪些编程智能体可以使用这些技能?任何支持 Agent Skills 规范的智能体都可以;README 中明确列出的支持对象有 Claude Code、Codex 和 OpenCode。
安装时有哪些需要注意的坑?使用 OpenCode 时,必须克隆整个仓库,而不能只克隆里面的 skills/ 文件夹,否则 SKILL.md 文件不会出现在 OpenCode 预期的路径中。
包含哪些技能?共五项技能:obsidian-markdown 用于 Obsidian 风格 Markdown 语法;obsidian-bases 用于 .base 文件(视图、筛选器、公式);json-canvas 用于 .canvas 文件;obsidian-cli 用于通过命令行管理库、插件和主题;defuddle 用于从网页中提取干净的 Markdown。
json-canvas 技能有什么用?它教智能体创建和编辑 JSON Canvas(.canvas)文件,包括节点、连线、分组和连接关系。
defuddle 技能有什么用?它会去除网页中的杂乱内容,让智能体提取出干净的 Markdown,从而在把网页内容输入大语言模型时节省 token。
这些技能能脱离 Obsidian 自身的插件系统使用吗?可以。它们遵循开放的 Agent Skills 规范,因此可以用于任何兼容的编程智能体,而不只限于 Obsidian 内部。
大小
0.2 MB
星标
53.1K
时长
10个月
提交 · 90 天