obsidian-master-skill
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
Chineseobsidian-master-skill
obsidian-master-skill
Unified skill for all Obsidian vault operations — note creation, search, vault health, knowledge capture, bases, and daily notes. Uses progressive disclosure: essential rules below, deep reference in .
reference/适用于所有Obsidian vault操作的统一技能集 —— 笔记创建、搜索、vault健康检测、知识捕获、bases和每日笔记。采用渐进式披露设计:核心规则如下,深度参考文档位于目录。
reference/Directory Structure
目录结构
obsidian-master-skill/
├── SKILL.md # This file (overview + quick reference)
├── reference/ # Detailed documentation
│ ├── markdown.md # Obsidian Flavored Markdown syntax
│ ├── vault-organization.md # PARA folders, frontmatter, Dataview
│ ├── rest-api.md # Local REST API, URI scheme, plugin API
│ ├── bases.md # .base YAML schema, filters, formulas
│ ├── integration-patterns.md # Claude Code integration patterns
│ └── knowledge-capture.md # ADR, concept, how-to, meeting templates
├── Workflows/ # Step-by-step workflow definitions
│ ├── CreateNote.md # Create notes with templates + PARA placement
│ ├── SearchVault.md # DQL, content search, tag filtering
│ ├── ManageVault.md # Health checks, orphans, broken links
│ ├── CaptureKnowledge.md # Extract insights from conversations
│ ├── CreateBase.md # Build .base database views
│ ├── DailyNote.md # Daily note creation/enhancement
│ ├── ProcessInbox.md # Triage inbox into PARA folders
│ └── SyncDocs.md # Sync external project docs to vault
└── Tools/ # Python CLI tools (click + httpx)
├── SearchVault.py # status, auth, search (dataview|content|jsonlogic)
├── VaultManager.py # health, orphans, broken-links, lifecycle, move, inbox
├── NoteCreator.py # create, daily, capture
└── BaseBuilder.py # create, validate, previewobsidian-master-skill/
├── SKILL.md # 本文件(概述 + 快速参考)
├── reference/ # 详细文档
│ ├── markdown.md # Obsidian风味Markdown语法
│ ├── vault-organization.md # PARA文件夹、frontmatter、Dataview
│ ├── rest-api.md # 本地REST API、URI方案、插件API
│ ├── bases.md # .base YAML schema、过滤器、公式
│ ├── integration-patterns.md # Claude Code集成模式
│ └── knowledge-capture.md # ADR、概念、教程、会议模板
├── Workflows/ # 分步工作流定义
│ ├── CreateNote.md # 使用模板创建笔记 + PARA归类
│ ├── SearchVault.md # DQL、内容搜索、标签过滤
│ ├── ManageVault.md # 健康检查、孤立笔记、无效链接
│ ├── CaptureKnowledge.md # 从对话中提取见解
│ ├── CreateBase.md # 构建.base数据库视图
│ ├── DailyNote.md # 每日笔记创建/优化
│ ├── ProcessInbox.md # 将收件箱内容分拣到PARA文件夹
│ └── SyncDocs.md # 将外部项目文档同步到vault
└── Tools/ # Python CLI工具(基于click + httpx)
├── SearchVault.py # 状态、认证、搜索(dataview|content|jsonlogic)
├── VaultManager.py # 健康、孤立笔记、无效链接、生命周期、移动、收件箱
├── NoteCreator.py # 创建、每日笔记、捕获
└── BaseBuilder.py # 创建、校验、预览Workflow Routing
工作流路由
| Intent | Workflow | Tool |
|---|---|---|
| Create a note (any type) | | |
| Search vault (DQL, content, tags) | | |
| Vault health, orphans, broken links | | |
| Extract knowledge from conversation | | |
| Create/edit .base database views | | |
| Daily note create/enhance | | |
| Process inbox notes into PARA | | |
| Sync project docs to vault | | |
| 意图 | 工作流 | 工具 |
|---|---|---|
| 创建任意类型的笔记 | | |
| 搜索vault(DQL、内容、标签) | | |
| vault健康检测、孤立笔记、无效链接 | | |
| 从对话中提取知识 | | |
| 创建/编辑.base数据库视图 | | |
| 创建/优化每日笔记 | | |
| 将收件箱笔记处理到PARA目录 | | |
| 同步项目文档到vault | | |
Quick Reference
快速参考
PARA Folder Map
PARA文件夹映射
| Folder | Purpose | Note Types |
|---|---|---|
| Quick capture, unsorted | Fleeting thoughts |
| Index notes | MOCs, dashboards |
| Active projects | Project docs |
| Ongoing responsibilities | Area overviews |
| Reference materials | Evergreen notes |
| Completed/inactive | Archived projects |
| Zettelkasten notes | Atomic ideas |
| Daily journal (YYYY/MM/YYYYMMDD.md) | Journal entries |
| Book notes | Reading notes |
| Meeting notes | 1-on-1s |
Deep dive:reference/vault-organization.md
| 文件夹 | 用途 | 笔记类型 |
|---|---|---|
| 快速捕获、未分类内容 | 瞬时想法 |
| 索引笔记 | MOC、仪表盘 |
| 进行中项目 | 项目文档 |
| 长期负责的领域 | 领域概览 |
| 参考资料 | 常青笔记 |
| 已完成/不活跃内容 | 归档项目 |
| Zettelkasten笔记 | 原子观点 |
| 每日日志(YYYY/MM/YYYYMMDD.md) | 日志条目 |
| 读书笔记 | 阅读笔记 |
| 会议笔记 | 1对1沟通记录 |
深度了解:reference/vault-organization.md
Frontmatter Schemas
Frontmatter Schema
Standard Note:
yaml
---
created: YYYY-MM-DDTHH:mm
updated: YYYY-MM-DDTHH:mm
tags:
- category/subcategory
---Daily Note (v2.0):
yaml
---
created: YYYY-MM-DDTHH:mm
updated: YYYY-MM-DDTHH:mm
title: YYYYMMDD
type: daily-note
status: true
tags:
- daily
- y/YYYY
- y/YYYY-MM
aliases:
- YYYY-MM-DD
date_formatted: YYYY-MM-DD
cssclasses:
- daily
---Project Note:
yaml
---
created: YYYY-MM-DDTHH:mm
updated: YYYY-MM-DDTHH:mm
type: project
status: active | paused | complete
priority: high | medium | low
tags:
- project/name
---Deep dive:reference/vault-organization.md
标准笔记:
yaml
---
created: YYYY-MM-DDTHH:mm
updated: YYYY-MM-DDTHH:mm
tags:
- category/subcategory
---每日笔记(v2.0):
yaml
---
created: YYYY-MM-DDTHH:mm
updated: YYYY-MM-DDTHH:mm
title: YYYYMMDD
type: daily-note
status: true
tags:
- daily
- y/YYYY
- y/YYYY-MM
aliases:
- YYYY-MM-DD
date_formatted: YYYY-MM-DD
cssclasses:
- daily
---项目笔记:
yaml
---
created: YYYY-MM-DDTHH:mm
updated: YYYY-MM-DDTHH:mm
type: project
status: active | paused | complete
priority: high | medium | low
tags:
- project/name
---深度了解:reference/vault-organization.md
Link Conventions
链接规范
markdown
[[Note Name]] # Wikilink
[[Note Name|Display Text]] # Aliased link
[[Note Name#Heading]] # Heading link
[[Note Name#^block-id]] # Block reference
![[Note Name]] # Embed note
![[image.png]] # Embed image
![[image.png|300]] # Embed with widthDeep dive:reference/markdown.md
markdown
[[Note Name]] # Wikilink
[[Note Name|Display Text]] # 别名链接
[[Note Name#Heading]] # 标题链接
[[Note Name#^block-id]] # 块引用
![[Note Name]] # 嵌入笔记
![[image.png]] # 嵌入图片
![[image.png|300]] # 指定宽度嵌入深度了解:reference/markdown.md
Common Dataview Queries
常用Dataview查询
dataview
LIST FROM "06 - Daily" WHERE file.cday = date(today) SORT file.ctime DESCdataview
TABLE status, tags FROM "01 - Projects" WHERE status != "completed"dataview
TABLE WITHOUT ID file.link AS "Note", file.mtime AS "Modified"
FROM "03 - Resources" SORT file.mtime DESC LIMIT 20dataview
LIST FROM "" WHERE length(file.inlinks) = 0 AND length(file.outlinks) = 0Deep dive:reference/vault-organization.md
dataview
LIST FROM "06 - Daily" WHERE file.cday = date(today) SORT file.ctime DESCdataview
TABLE status, tags FROM "01 - Projects" WHERE status != "completed"dataview
TABLE WITHOUT ID file.link AS "Note", file.mtime AS "Modified"
FROM "03 - Resources" SORT file.mtime DESC LIMIT 20dataview
LIST FROM "" WHERE length(file.inlinks) = 0 AND length(file.outlinks) = 0深度了解:reference/vault-organization.md
Knowledge Capture Signals
知识捕获信号
| Signal in Conversation | Capture Type | Destination |
|---|---|---|
| "We decided to..." | ADR | |
| "What is X?" / "X works by..." | Concept | |
| "How do I..." / "Steps to..." | How-To | |
| "In the meeting..." | Meeting Note | |
| "Track all notes about..." | MOC | |
| Quick insight or todo | Daily Append | |
Deep dive:reference/knowledge-capture.md
| 对话中的信号 | 捕获类型 | 存储位置 |
|---|---|---|
| "我们决定..." | ADR | |
| "X是什么?" / "X的运行原理是..." | 概念 | |
| "我要怎么..." / "操作步骤是..." | 教程 | |
| "在会议上..." | 会议笔记 | |
| "收集所有关于...的笔记" | MOC | |
| 快速见解或待办 | 追加到每日笔记 | |
深度了解:reference/knowledge-capture.md
Callout Types
标注框类型
markdown
> [!note] Title
> Content
> [!tip]+ Expandable (default open)
> [!info]- Collapsed (default closed)Types: , , , , , , , , , , , ,
noteabstract/summary/tldrinfotodotip/hint/importantsuccess/check/donequestion/help/faqwarning/caution/attentionfailure/fail/missingdanger/errorbugexamplequote/citeDeep dive:reference/markdown.md
markdown
> [!note] 标题
> 内容
> [!tip]+ 可展开(默认展开)
> [!info]- 可折叠(默认收起)类型:, , , , , , , , , , , ,
noteabstract/summary/tldrinfotodotip/hint/importantsuccess/check/donequestion/help/faqwarning/caution/attentionfailure/fail/missingdanger/errorbugexamplequote/cite深度了解:reference/markdown.md
REST API Quick Start
REST API快速入门
bash
undefinedbash
undefinedRequires Local REST API plugin enabled in Obsidian
需要在Obsidian中启用Local REST API插件
export OBSIDIAN_API_KEY="your-key"
export OBSIDIAN_BASE_URL="https://127.0.0.1:27124"
curl -H "Authorization: Bearer $OBSIDIAN_API_KEY" $OBSIDIAN_BASE_URL/vault/
| Endpoint | Method | Purpose |
|----------|--------|---------|
| `/vault/{path}` | GET/PUT/DELETE/PATCH | File CRUD |
| `/search/simple/` | POST | Text search |
| `/search/` | POST | Dataview query |
| `/search/jsonlogic/` | POST | Complex filtering |
| `/active/` | GET/PUT | Active file |
| `/commands/{id}` | POST | Execute command |
> Deep dive: `reference/rest-api.md`export OBSIDIAN_API_KEY="your-key"
export OBSIDIAN_BASE_URL="https://127.0.0.1:27124"
curl -H "Authorization: Bearer $OBSIDIAN_API_KEY" $OBSIDIAN_BASE_URL/vault/
| 端点 | 方法 | 用途 |
|----------|--------|---------|
| `/vault/{path}` | GET/PUT/DELETE/PATCH | 文件CRUD |
| `/search/simple/` | POST | 文本搜索 |
| `/search/` | POST | Dataview查询 |
| `/search/jsonlogic/` | POST | 复杂过滤 |
| `/active/` | GET/PUT | 当前活跃文件 |
| `/commands/{id}` | POST | 执行命令 |
> 深度了解:`reference/rest-api.md`Base Files Quick Start
Base文件快速入门
yaml
undefinedyaml
undefinedexample.base — table of active projects
example.base — 活跃项目表格
filters:
and:
- file.inFolder("01 - Projects")
- 'status == "active"'
views:
- type: table name: "Active Projects" order: [file.name, status, priority, due_date]
Embed: `![[example.base]]` or `![[example.base#View Name]]`
> Deep dive: `reference/bases.md`filters:
and:
- file.inFolder("01 - Projects")
- 'status == "active"'
views:
- type: table name: "Active Projects" order: [file.name, status, priority, due_date]
嵌入方式:`![[example.base]]` 或 `![[example.base#视图名称]]`
> 深度了解:`reference/bases.md`Tools (Python)
工具(Python)
All tools use CLI, for REST API, for frontmatter, for direct file access. Dual mode: REST API when Obsidian running, direct file fallback otherwise.
clickhttpxpyyamlpathlib| Tool | Commands |
|---|---|
| |
| |
| |
| |
所有工具使用实现CLI、调用REST API、处理frontmatter、直接访问文件。双模式运行:Obsidian运行时使用REST API,否则回退到直接文件访问。
clickhttpxpyyamlpathlib| 工具 | 命令 |
|---|---|
| |
| |
| |
| |
Examples
示例
"Create a new project note for API redesign" -> Workflows/CreateNote.md
"Search my vault for notes about Kubernetes" -> Workflows/SearchVault.md
"Find orphan notes and suggest connections" -> Workflows/ManageVault.md
"Save what we just discussed as an ADR" -> Workflows/CaptureKnowledge.md
"Create a base view of all active projects" -> Workflows/CreateBase.md
"Create today's daily note" -> Workflows/DailyNote.md
"Process my inbox" -> Workflows/ProcessInbox.md
"What's the Obsidian markdown syntax for X?" -> reference/markdown.md
"How do I use the REST API?" -> reference/rest-api.md
"How do bases formulas work?" -> reference/bases.md"为API重构创建新的项目笔记" -> Workflows/CreateNote.md
"在我的vault中搜索Kubernetes相关笔记" -> Workflows/SearchVault.md
"查找孤立笔记并建议关联" -> Workflows/ManageVault.md
"把我们刚刚讨论的内容保存为ADR" -> Workflows/CaptureKnowledge.md
"创建所有活跃项目的base视图" -> Workflows/CreateBase.md
"创建今天的每日笔记" -> Workflows/DailyNote.md
"处理我的收件箱" -> Workflows/ProcessInbox.md
"Obsidian中X对应的markdown语法是什么?" -> reference/markdown.md
"我要怎么使用REST API?" -> reference/rest-api.md
"bases公式的工作原理是什么?" -> reference/bases.mdNeovim Reference
Neovim参考
For obsidian.nvim configuration, see section on Neovim integration.
reference/integration-patterns.md如需obsidian.nvim配置,请查看中Neovim集成的相关章节。
reference/integration-patterns.md