obsidian-dev-rules — скилл для Claude Code
Скилл obsidian-dev-rules для Claude Code содержит правила разработки плагинов на TypeScript и тем оформления для Obsidian. Помогает работать с Vault и Editor API без утечек памяти.
MIT 317 установок ★ 107 обновлён 2026-10-16
npx skills add Agents365-ai/365-skills --skill obsidian-dev-rules -a claude-codeЧто делает obsidian-dev-rules
Скилл содержит правила разработки плагинов и тем для Obsidian по официальной документации. Он подсказывает структуру manifest.json, жизненный цикл класса Plugin, регистрацию команд, настроек и представлений через интерфейсы Modal и ItemView. Для вёрстки интерфейса здесь закреплён отказ от innerHTML в пользу вызовов createEl и стилей через переменные Obsidian.
Внутри собраны требования к работе с заметками. Скилл запрещает последовательные вызовы read и modify, требуя атомарный метод process, и следит за обращением через this.app вместо глобального объекта. Без регистрации обработчиков через registerEvent или registerDomEvent таймеры и слушатели останутся висеть в памяти после выключения плагина.
Тут же описаны правила публикации в каталог сообщества: сборка без zip-архивов с отдельными файлами main.js и manifest.json, валидация идентификатора плагина и запрет стандартных горячих клавиш.
Какие задачи решает
- разработать плагин для Obsidian на TypeScript
- переписать прямое чтение и запись заметок на атомарный метод
process - сверстать интерфейс настроек и модальных окон без
innerHTML - подготовить плагин к публикации в каталоге сообщества Obsidian
Примеры запросов агенту
- Помоги настроить жизненный цикл плагина в
onloadи корректно почистить ресурсы - Напиши команду для замены текста в активной заметке через Editor API
- Проверь
manifest.jsonи файлы сборки перед созданием релиза на GitHub
Как установить obsidian-dev-rules
1Через Skills CLI (Vercel)
npx skills add Agents365-ai/365-skills --skill obsidian-dev-rules -a claude-code2Вручную: положить файлы
~/.claude/skills/obsidian-dev-rules/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/obsidian-dev-rules/
1Через Skills CLI (Vercel)
npx skills add Agents365-ai/365-skills --skill obsidian-dev-rules -a codex2Вручную: положить файлы
.agents/skills/obsidian-dev-rules/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add Agents365-ai/365-skills --skill obsidian-dev-rules -a cursor2Вручную: положить файлы
.cursor/skills/obsidian-dev-rules/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install Agents365-ai/365-skills plugins/obsidian-dev-rules/skills/obsidian-dev-rules2Вручную: положить файлы
.github/skills/obsidian-dev-rules/SKILL.md1Через Skills CLI (Vercel)
npx skills add Agents365-ai/365-skills --skill obsidian-dev-rules -a gemini-cli2Командой платформы
gemini skills install https://github.com/Agents365-ai/365-skills --path plugins/obsidian-dev-rules/skills/obsidian-dev-rulesВручную: положить файлы
.devin/skills/obsidian-dev-rules/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add Agents365-ai/365-skills --skill obsidian-dev-rules -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы об obsidian-dev-rules
Как установить obsidian-dev-rules в Claude Code?
Выполните команду npx skills add Agents365-ai/365-skills --skill obsidian-dev-rules -a claude-code. Конфигурация запишется по пути ~/.claude/skills/obsidian-dev-rules/SKILL.md.
Что делает скилл obsidian-dev-rules?
Он задаёт контекст для создания расширений и тем Obsidian. Скилл регламентирует методы Vault API, расширения CodeMirror 6, работу с окнами и стандарты очистки ресурсов.
Зачем использовать process вместо последовательных read и modify?
Метод process обновляет файл атомарно. Это исключает потерю правок, если содержимое заметки успело измениться во время асинхронной паузы между чтением и записью.
Исходный текст
SKILL.md · MIT
---
disable-model-invocation: true
name: obsidian-dev-rules
description: Authoritative reference and rules for developing for Obsidian — building TypeScript plugins (Plugin lifecycle, manifest.json, commands, settings, modals, views, ribbon/status bar), the Vault and Editor APIs, the event system, Markdown post-processing & code-block processors, CodeMirror 6 editor extensions, building CSS themes (CSS variables, theme.css/manifest), and submitting plugins/themes to the community directory. Use whenever the user asks to build, debug, or review an Obsidian plugin or theme, work with the Obsidian API (Vault/Editor/Workspace/Plugin), register commands/views/events, process Markdown, or release/submit to the Obsidian community.
license: MIT
metadata: {"source":"https://docs.obsidian.md/Home","docVersion":"latest","fetched":"2026-05-24"}
---
# Obsidian Dev Rules
Obsidian is extended two ways: **plugins** (TypeScript against the Obsidian API) and **themes/snippets**
(CSS). This skill mirrors the official developer docs at https://docs.obsidian.md so you can build and
review Obsidian plugins/themes without re-fetching. The API ships as the `obsidian` npm package; the
canonical starting point is the [`obsidian-sample-plugin`](https://github.com/obsidianmd/obsidian-sample-plugin).
## When to use this skill
- Building, debugging, or reviewing an **Obsidian plugin** (lifecycle, commands, settings, UI, views).
- Reading/writing notes via the **Vault** API; manipulating the active note via the **Editor** API.
- Subscribing to **events**, registering **Markdown post-processors** / code-block processors, or
**CodeMirror 6** editor extensions.
- Building a **theme** (CSS variables, `theme.css`, manifest) or snippets.
- **Releasing/submitting** a plugin or theme to the community directory.
## Reference index — load the file you need
| File | Covers |
|------|--------|
| `references/plugin-basics.md` | Project setup, `manifest.json`, Plugin lifecycle (`onload`/`onunload`), resource registration & cleanup, events, dev workflow / hot reload, debugging |
| `references/vault-and-editor.md` | Vault API (read/cachedRead/create/modify/process/delete, TFile/TFolder, adapter, normalizePath), Editor API, Markdown post-processing & code-block processors, CodeMirror 6 editor extensions |
| `references/ui.md` | Commands (callback variants, hotkeys), Settings (PluginSettingTab, load/saveData, Setting controls), Modals (Modal/SuggestModal/FuzzySuggestModal), Views (ItemView, registerView, workspace leaves), ribbon/status bar |
| `references/themes-and-release.md` | Themes (CSS variables, theme.css/manifest, body classes, snippets), submitting plugins & themes, developer policies & guidelines |
## Cheat sheet
```ts
import { Plugin, Notice, MarkdownView, TFile, normalizePath } from 'obsidian';
export default class MyPlugin extends Plugin {
async onload() {
await this.loadSettings();
this.addRibbonIcon('dice', 'Greet', () => new Notice('Hello!'));
this.addCommand({ id: 'do-x', name: 'Do X', callback: () => {/* ... */} });
this.addSettingTab(new MySettingTab(this.app, this));
// Auto-cleaned on unload — always register through these:
this.registerEvent(this.app.vault.on('modify', (f) => {/* ... */}));
this.registerInterval(window.setInterval(() => {/* ... */}, 1000));
this.registerDomEvent(document, 'click', () => {/* ... */});
}
onunload() { /* release anything NOT registered via register*/ }
}
```
```ts
// Vault: prefer process() over read()+modify(); use cachedRead() for display only.
const file = this.app.vault.getFileByPath('Notes/x.md');
await this.app.vault.process(file, (data) => data.replace('foo', 'bar'));
// Editor of the active note (preserves cursor/selection):
const view = this.app.workspace.getActiveViewOfType(MarkdownView);
view?.editor.replaceSelection(view.editor.getSelection().toUpperCase());
```
**Plugin files**: `manifest.json` + `main.js` (+ optional `styles.css`) in `<vault>/.obsidian/plugins/<id>/`.
**Theme files**: `manifest.json` + `theme.css` in `<vault>/.obsidian/themes/<name>/`.
## Hard rules
- **Use `this.app`, never the global `app`** (global exists for debugging only and may be removed).
- **Register everything that needs teardown** via `registerEvent` / `registerInterval` /
`registerDomEvent` / `addCommand` / `registerView` / `registerMarkdownPostProcessor` — Obsidian
auto-cleans those on unload. Manually release anything else in `onunload()`. Leaked listeners/
intervals degrade Obsidian after the plugin is disabled.
- **Never** use `innerHTML` / `outerHTML` / `insertAdjacentHTML` with dynamic content — build DOM with
`createEl()` / `createDiv()` / `createSpan()`.
- **Prefer the Vault API over the Adapter API**; use `getFileByPath()` (not iterate-all); always
`normalizePath()` user-supplied paths. Use **`process()`** (atomic) instead of sequential
`read()`+`modify()` to avoid data loss; `cachedRead()` only when you won't write it back.
- **For the active note, edit via the Editor interface**, not `Vault.modify` — it preserves the
cursor and selection.
- **Don't store references to view instances**; Obsidian may recreate them — fetch with
`getLeavesOfType()` / `getActiveViewOfType()`.
- **Don't set default hotkeys** for distributed plugins (OS-dependent, conflict-prone). UI text is
**sentence case**. Use CSS classes + Obsidian CSS variables, not hardcoded inline styles.
- **`manifest.json` required fields**: `id`, `name`, `version` (semver `x.y.z`), `minAppVersion`,
`description`, `author`, `isDesktopOnly`. `id` must **not** contain "obsidian"; `name` is Basic-Latin,
no emoji/punctuation except hyphens.
- **Release**: GitHub release whose **tag equals the manifest `version`**, with `main.js`,
`manifest.json`, and optional `styles.css` attached as **individual binary assets** (not zipped).
- Use `async`/`await` (not Promise chains); `const`/`let` (not `var`).
© Agents365-ai · MIT · Agents365-ai/365-skills