关于 obsidian
面向 Obsidian 插件开发者和桌面自动化用户的技能,涵盖插件构建、CLI 操作与 Markdown 内容模式,并按意图引导到相应流程。
主要功能
- 01生成插件基础代码并检查 ESLint 规则
- 02通过 CLI 搜索、读取和更新笔记
- 03使用 URI 将请求交给 Obsidian
- 04提供 Markdown、Bases 和 Canvas 模式
适用场景
- 01创建插件并修复 lint 问题
- 02自动搜索笔记或追加每日笔记
- 03为插件提交准备代码与可访问性检查
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ akillness/ jeo-skills --skill obsidian安装后在 Claude Code 中输入/obsidian确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/cli-automation.mdcontent-patterns.mdplugin-dev.md详细介绍
obsidian — 插件开发 + 桌面自动化
替代:
obsidian-plugin·obsidian-cli插件安装:claude plugin marketplace add akillness/jeo-skills技能安装:npx skills add https://github.com/akillness/jeo-skills --skill obsidian
何时使用此技能
插件开发路径:
- 使用简洁的样板代码(不含冗余内容)生成新的 Obsidian 插件
- 修复
eslint-plugin-obsidianmd中的 ESLint 违规(27 条规则) - 为提交到社区目录准备插件
- 应用内存安全的生命周期、类型安全、无障碍设计和 CSS 变量
CLI 自动化路径:
- 通过官方 CLI(
obsidian命令)操作桌面版 Obsidian - 执行 vault/笔记定位、每日笔记、搜索、创建、读取和任务操作
- 使用
obsidian://URI 从启动器/浏览器/脚本将操作交接给应用 - 插件/主题开发循环(重新加载、截图、eval、开发者工具)
Markdown 与内容模式(kepano/obsidian-skills):
- Wikilinks、嵌入、提示框、frontmatter、Obsidian Bases 查询、JSON Canvas
何时不使用此技能
- 无桌面环境的无头 Sync/Publish → Obsidian Headless
- 直接编辑 Markdown 文件系统 → 直接写入文件系统
- Shell 原生笔记后端 →
nb、zk或 Joplin Terminal - 更丰富的外部 CRUD/frontmatter 操作 → Local REST API 或 Advanced URI 插件
说明
路由:先选择路径
obsidian_intent:
path: plugin-dev | cli-automation | markdown-patterns
surface: boilerplate | eslint-fix | submission | cli-command | uri-handoff | developer-mode | content-patterns
插件开发快速入门
# Generate boilerplate
npx github:gapmiss/obsidian-plugin-skill create-plugin
# Install ESLint validation
npm install --save-dev eslint eslint-plugin-obsidianmd
npx eslint src/ # validate all 27 rules
npx eslint src/ --fix # auto-fix where possible
关键规则:prefer-register-event(内存)、no-tfile-cast(类型安全)、
require-aria-label(无障碍设计)、prefer-css-variables(样式)。
所有 27 条规则和代码模式请参阅 references/plugin-dev.md。
CLI 自动化快速入门
obsidian help && obsidian version # verify CLI is enabled
obsidian vault="My Vault" search query="meeting notes"
obsidian vault="My Vault" read path="Projects/Roadmap.md"
obsidian daily:append content="- [ ] Follow up"
obsidian plugin:reload id=my-plugin # developer mode
URI 交接:
obsidian://open?vault=my%20vault&file=my%20note
obsidian://new?vault=my%20vault&name=new-note
完整命令参考请参阅 references/cli-automation.md。
Markdown 与内容模式(kepano)
- Wikilinks:
[[Note Name]]、[[Note|Alias]]、[[Note#Heading]] - 嵌入:
![[Note]]、![[image.png|300]] - 提示框:
> [!NOTE]、> [!WARNING]、> [!TIP] - Bases:使用
\``base查询,并搭配from、filter、sort、group` - JSON Canvas:用于可视化知识图谱的节点 + 边结构
完整语法请参阅 references/content-patterns.md。
插件安装与分发
# Install this skill as a Claude Code plugin
claude plugin marketplace add akillness/jeo-skills
# Or install just the obsidian skill via skills CLI
npx skills add https://github.com/akillness/jeo-skills --skill obsidian
示例
# Example 1: verify CLI availability, then search and append to daily note
obsidian version
obsidian vault="Work" search query="incident postmortem"
obsidian daily:append content="- [ ] Share postmortem summary"
# Example 2: plugin-dev lint/fix loop before submission
npm install --save-dev eslint eslint-plugin-obsidianmd
npx eslint src/
npx eslint src/ --fix
参考资料
- references/plugin-dev.md — 全部 27 条 ESLint 规则、代码模式和提交说明
- references/cli-automation.md — CLI 命令、URI、开发者模式
- references/content-patterns.md — Markdown、Bases、JSON Canvas
- eslint-plugin-obsidianmd
- Obsidian 插件文档
- Obsidian CLI
- kepano/obsidian-skills
最佳实践
- 保持输出确定且可审计。
- 优先采用小幅、可逆的更改,避免大范围高风险编辑。
- 明确记录假设。
评论
支持 Markdown