obsidian

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

obsidian — Plugin Development + Desktop Automation

obsidian — 插件开发 + 桌面自动化

Replaces:

obsidian-plugin

obsidian-cli

Plugin install:

claude plugin marketplace add akillness/oh-my-skills

Skill install:

npx skills add https://github.com/akillness/oh-my-skills --skill obsidian

替代：

obsidian-plugin

obsidian-cli

插件安装：

claude plugin marketplace add akillness/oh-my-skills

技能安装：

npx skills add https://github.com/akillness/oh-my-skills --skill obsidian

When to use this skill

使用场景

Plugin development path:

Generate a new Obsidian plugin with clean boilerplate (no bloat)
Fix ESLint violations from
```
eslint-plugin-obsidianmd
```
(27 rules)
Prepare a plugin for community directory submission
Apply memory-safe lifecycle, type safety, accessibility, CSS variables

CLI automation path:

Drive desktop Obsidian via official CLI (
```
obsidian
```
command)
Execute vault/note targeting, daily-note, search, create, read, tasks
Use
```
obsidian://
```
URI for app handoff from launchers/browsers/scripts
Plugin/theme development loop (reload, screenshot, eval, devtools)

Markdown & content patterns (kepano/obsidian-skills):

Wikilinks, embeds, callouts, frontmatter, Obsidian Bases queries, JSON Canvas

插件开发场景：

生成无冗余的简洁Obsidian插件模板
修复
```
eslint-plugin-obsidianmd
```
的ESLint违规问题（共27条规则）
准备插件提交至社区目录
应用内存安全的生命周期、类型安全、可访问性、CSS变量

CLI自动化场景：

通过官方CLI（
```
obsidian
```
命令）驱动桌面版Obsidian
执行库/笔记定位、每日笔记、搜索、创建、读取、任务操作
使用
```
obsidian://
```
URI从启动器/浏览器/脚本切换至Obsidian应用
插件/主题开发循环（重载、截图、求值、开发者工具）

Markdown与内容模式（kepano/obsidian-skills）：

维基链接、嵌入、提示框、前置元数据、Obsidian Bases查询、JSON Canvas

When not to use this skill

不适用场景

Headless Sync/Publish without desktop → Obsidian Headless
Raw filesystem markdown edits → direct filesystem writes
Shell-native notes backend →
```
nb
```
,
```
zk
```
, or Joplin Terminal
Richer external CRUD/frontmatter → Local REST API or Advanced URI plugin

无桌面端的无头同步/发布 → 使用Obsidian Headless
直接编辑文件系统中的markdown → 直接写入文件系统
原生Shell笔记后端 → 使用
```
nb
```
、
```
zk
```
或Joplin Terminal
更丰富的外部增删改查/前置元数据 → 使用Local REST API或Advanced URI插件

Instructions

使用说明

Routing: choose your path first

路由：先选择你的场景

yaml

obsidian_intent:
  path: plugin-dev | cli-automation | markdown-patterns
  surface: boilerplate | eslint-fix | submission | cli-command | uri-handoff | developer-mode | content-patterns

yaml

obsidian_intent:
  path: plugin-dev | cli-automation | markdown-patterns
  surface: boilerplate | eslint-fix | submission | cli-command | uri-handoff | developer-mode | content-patterns

Plugin development quick start

插件开发快速开始

bash

undefined

bash

undefined

Generate boilerplate

生成模板

npx github:gapmiss/obsidian-plugin-skill create-plugin

Install ESLint validation

安装ESLint校验

npm install --save-dev eslint eslint-plugin-obsidianmd npx eslint src/ # validate all 27 rules npx eslint src/ --fix # auto-fix where possible


Key rules: `prefer-register-event` (memory), `no-tfile-cast` (type safety),
`require-aria-label` (accessibility), `prefer-css-variables` (styling).
See [references/plugin-dev.md](references/plugin-dev.md) for all 27 rules + code patterns.

npm install --save-dev eslint eslint-plugin-obsidianmd npx eslint src/ # 校验全部27条规则 npx eslint src/ --fix # 自动修复可处理的问题


核心规则：`prefer-register-event`（内存优化）、`no-tfile-cast`（类型安全）、`require-aria-label`（可访问性）、`prefer-css-variables`（样式规范）。查看[references/plugin-dev.md](references/plugin-dev.md)获取全部27条规则及代码示例。

CLI automation quick start

CLI自动化快速开始

bash

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 handoff:

obsidian://open?vault=my%20vault&file=my%20note
obsidian://new?vault=my%20vault&name=new-note

See references/cli-automation.md for full command reference.

bash

obsidian help && obsidian version   # 验证CLI已启用
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   # 开发者模式

URI跳转：

obsidian://open?vault=my%20vault&file=my%20note
obsidian://new?vault=my%20vault&name=new-note

查看references/cli-automation.md获取完整命令参考。

Markdown & content patterns (kepano)

Markdown与内容模式（kepano）

Wikilinks:

[[Note Name]]

[[Note|Alias]]

[[Note#Heading]]

Embeds:
```
![[Note]]
```
,
```
![[image.png|300]]
```
Callouts:
```
> [!NOTE]
```
,
```
> [!WARNING]
```
,
```
> [!TIP]
```
Bases:
```
\
```
``base
```
queries with
```
from
```
, 
```
filter
```
, 
```
sort
```
, 
```
group`
JSON Canvas: nodes + edges structure for visual knowledge graphs

See references/content-patterns.md for full syntax.

维基链接：

[[Note Name]]

[[Note|Alias]]

[[Note#Heading]]

嵌入：
```
![[Note]]
```
,
```
![[image.png|300]]
```
提示框：
```
> [!NOTE]
```
,
```
> [!WARNING]
```
,
```
> [!TIP]
```
Bases：带有
```
from
```
,
```
filter
```
,
```
sort
```
,
```
group
```
的
```
\
```
``base`查询
JSON Canvas：用于可视化知识图谱的节点+边结构

查看references/content-patterns.md获取完整语法。

Plugin install & distribution

插件安装与分发

bash

undefined

bash

undefined

Install this skill as a Claude Code plugin

将此技能安装为Claude Code插件

claude plugin marketplace add akillness/oh-my-skills

Or install just the obsidian skill via skills CLI

或通过skills CLI仅安装obsidian技能

npx skills add https://github.com/akillness/oh-my-skills --skill obsidian

undefined

npx skills add https://github.com/akillness/oh-my-skills --skill obsidian

undefined

Examples

示例

bash

undefined

bash

undefined

Example 1: verify CLI availability, then search and append to daily note

示例1：验证CLI可用性，搜索并追加内容至每日笔记

obsidian version obsidian vault="Work" search query="incident postmortem" obsidian daily:append content="- [ ] Share postmortem summary"


```bash

obsidian version obsidian vault="Work" search query="incident postmortem" obsidian daily:append content="- [ ] 分享事后总结"


```bash

Example 2: plugin-dev lint/fix loop before submission

示例2：插件开发提交前的 lint/修复循环

npm install --save-dev eslint eslint-plugin-obsidianmd npx eslint src/ npx eslint src/ --fix

undefined

npm install --save-dev eslint eslint-plugin-obsidianmd npx eslint src/ npx eslint src/ --fix

undefined

References

参考资料

references/plugin-dev.md — All 27 ESLint rules, code patterns, submission
references/cli-automation.md — CLI commands, URI, developer mode
references/content-patterns.md — Markdown, Bases, JSON Canvas
eslint-plugin-obsidianmd
Obsidian Plugin Docs
Obsidian CLI
kepano/obsidian-skills

references/plugin-dev.md — 全部27条ESLint规则、代码示例、提交指南
references/cli-automation.md — CLI命令、URI、开发者模式
references/content-patterns.md — Markdown、Bases、JSON Canvas
eslint-plugin-obsidianmd
Obsidian Plugin Docs
Obsidian CLI
kepano/obsidian-skills

Best practices

最佳实践

Keep outputs deterministic and auditable.
Prefer small reversible changes over broad risky edits.
Record assumptions explicitly.

保持输出可确定且可审计。
优先选择小的可逆变更，而非大范围的高风险编辑。
明确记录假设条件。