obsidian-master-skill

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

obsidian-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, preview
obsidian-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

工作流路由

IntentWorkflowTool
Create a note (any type)
Workflows/CreateNote.md
Tools/NoteCreator.py
Search vault (DQL, content, tags)
Workflows/SearchVault.md
Tools/SearchVault.py
Vault health, orphans, broken links
Workflows/ManageVault.md
Tools/VaultManager.py
Extract knowledge from conversation
Workflows/CaptureKnowledge.md
Tools/NoteCreator.py
Create/edit .base database views
Workflows/CreateBase.md
Tools/BaseBuilder.py
Daily note create/enhance
Workflows/DailyNote.md
Tools/NoteCreator.py
Process inbox notes into PARA
Workflows/ProcessInbox.md
Tools/VaultManager.py
Sync project docs to vault
Workflows/SyncDocs.md
Tools/VaultManager.py
意图工作流工具
创建任意类型的笔记
Workflows/CreateNote.md
Tools/NoteCreator.py
搜索vault(DQL、内容、标签)
Workflows/SearchVault.md
Tools/SearchVault.py
vault健康检测、孤立笔记、无效链接
Workflows/ManageVault.md
Tools/VaultManager.py
从对话中提取知识
Workflows/CaptureKnowledge.md
Tools/NoteCreator.py
创建/编辑.base数据库视图
Workflows/CreateBase.md
Tools/BaseBuilder.py
创建/优化每日笔记
Workflows/DailyNote.md
Tools/NoteCreator.py
将收件箱笔记处理到PARA目录
Workflows/ProcessInbox.md
Tools/VaultManager.py
同步项目文档到vault
Workflows/SyncDocs.md
Tools/VaultManager.py

Quick Reference

快速参考

PARA Folder Map

PARA文件夹映射

FolderPurposeNote Types
00 - Inbox/
Quick capture, unsortedFleeting thoughts
00 - Maps of Content/
Index notesMOCs, dashboards
01 - Projects/
Active projectsProject docs
02 - Areas/
Ongoing responsibilitiesArea overviews
03 - Resources/
Reference materialsEvergreen notes
04 - Archive/
Completed/inactiveArchived projects
04 - Permanent/
Zettelkasten notesAtomic ideas
06 - Daily/
Daily journal (YYYY/MM/YYYYMMDD.md)Journal entries
08 - books/
Book notesReading notes
10 - 1-1/
Meeting notes1-on-1s
Deep dive:
reference/vault-organization.md
文件夹用途笔记类型
00 - Inbox/
快速捕获、未分类内容瞬时想法
00 - Maps of Content/
索引笔记MOC、仪表盘
01 - Projects/
进行中项目项目文档
02 - Areas/
长期负责的领域领域概览
03 - Resources/
参考资料常青笔记
04 - Archive/
已完成/不活跃内容归档项目
04 - Permanent/
Zettelkasten笔记原子观点
06 - Daily/
每日日志(YYYY/MM/YYYYMMDD.md)日志条目
08 - books/
读书笔记阅读笔记
10 - 1-1/
会议笔记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 width
Deep 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 DESC
dataview
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 20
dataview
LIST FROM "" WHERE length(file.inlinks) = 0 AND length(file.outlinks) = 0
Deep dive:
reference/vault-organization.md
dataview
LIST FROM "06 - Daily" WHERE file.cday = date(today) SORT file.ctime DESC
dataview
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 20
dataview
LIST FROM "" WHERE length(file.inlinks) = 0 AND length(file.outlinks) = 0
深度了解:
reference/vault-organization.md

Knowledge Capture Signals

知识捕获信号

Signal in ConversationCapture TypeDestination
"We decided to..."ADR
03 - Resources/decisions/
"What is X?" / "X works by..."Concept
04 - Permanent/
"How do I..." / "Steps to..."How-To
03 - Resources/howtos/
"In the meeting..."Meeting Note
10 - 1-1/
"Track all notes about..."MOC
00 - Maps of Content/
Quick insight or todoDaily Append
06 - Daily/YYYY/MM/YYYYMMDD.md
Deep dive:
reference/knowledge-capture.md
对话中的信号捕获类型存储位置
"我们决定..."ADR
03 - Resources/decisions/
"X是什么?" / "X的运行原理是..."概念
04 - Permanent/
"我要怎么..." / "操作步骤是..."教程
03 - Resources/howtos/
"在会议上..."会议笔记
10 - 1-1/
"收集所有关于...的笔记"MOC
00 - Maps of Content/
快速见解或待办追加到每日笔记
06 - Daily/YYYY/MM/YYYYMMDD.md
深度了解:
reference/knowledge-capture.md

Callout Types

标注框类型

markdown
> [!note] Title
> Content

> [!tip]+ Expandable (default open)
> [!info]- Collapsed (default closed)
Types:
note
,
abstract/summary/tldr
,
info
,
todo
,
tip/hint/important
,
success/check/done
,
question/help/faq
,
warning/caution/attention
,
failure/fail/missing
,
danger/error
,
bug
,
example
,
quote/cite
Deep dive:
reference/markdown.md
markdown
> [!note] 标题
> 内容

> [!tip]+ 可展开(默认展开)
> [!info]- 可折叠(默认收起)
类型:
note
,
abstract/summary/tldr
,
info
,
todo
,
tip/hint/important
,
success/check/done
,
question/help/faq
,
warning/caution/attention
,
failure/fail/missing
,
danger/error
,
bug
,
example
,
quote/cite
深度了解:
reference/markdown.md

REST API Quick Start

REST API快速入门

bash
undefined
bash
undefined

Requires 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
undefined
yaml
undefined

example.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
click
CLI,
httpx
for REST API,
pyyaml
for frontmatter,
pathlib
for direct file access. Dual mode: REST API when Obsidian running, direct file fallback otherwise.
ToolCommands
Tools/SearchVault.py
status
,
auth
,
search --type dataview|content|jsonlogic
Tools/VaultManager.py
health
,
orphans
,
broken-links
,
lifecycle
,
move
,
inbox
Tools/NoteCreator.py
create
,
daily
,
capture
Tools/BaseBuilder.py
create
,
validate
,
preview
所有工具使用
click
实现CLI、
httpx
调用REST API、
pyyaml
处理frontmatter、
pathlib
直接访问文件。双模式运行:Obsidian运行时使用REST API,否则回退到直接文件访问。
工具命令
Tools/SearchVault.py
status
,
auth
,
search --type dataview|content|jsonlogic
Tools/VaultManager.py
health
,
orphans
,
broken-links
,
lifecycle
,
move
,
inbox
Tools/NoteCreator.py
create
,
daily
,
capture
Tools/BaseBuilder.py
create
,
validate
,
preview

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.md

Neovim Reference

Neovim参考

For obsidian.nvim configuration, see
reference/integration-patterns.md
section on Neovim integration.
如需obsidian.nvim配置,请查看
reference/integration-patterns.md
中Neovim集成的相关章节。