Obsidian 知识库初始化
Purpose
以固定模板为唯一标准初始化新的 Obsidian 知识库:完整复制模板(含 .obsidian 配置和全部社区插件),知识库名就是新库的文件夹名,库内内容零修改。
Context
- 标准模板(内置于本 skill,勿改):
<本 skill 目录>/assets/template/;要更新标准,直接编辑 assets/template/ - 默认创建位置:
~/Documents/Obsidian/(用户指定其他位置时以用户为准) - 唯一必填输入:知识库名
- 模板内容概要:
.obsidian/(核心插件配置 + 3 个社区插件:tag-wrangler、obsidian-local-images-plus、obsidian-linter)+AGENTS.md(库治理规则)+README.md(库简介)+raw/、wiki/两个空内容层(.gitkeep 占位),共 18 个文件;插件版本、配置细节见references/template.md - 模板内部没有任何硬编码库名的字段,因此除文件夹名外无需任何内容替换
Instructions
- 确定知识库名。 用户没给名字时先询问,这是唯一必填信息。除非用户明确指定了其他位置,一律建在默认创建位置,不要自行换目录。
- 运行初始化脚本:
bash
bash <本 skill 目录>/scripts/init_vault.sh "<知识库名>" [目标父目录]
脚本负责:校验名字合法性、检查重名(已存在则报错退出,绝不覆盖)、用 ditto 完整复制(含隐藏目录)、校验新库文件数与模板一致且关键结构齐全。脚本失败时把错误信息如实告诉用户,不要手动改用其他复制方式绕过校验;失败排查见 references/troubleshooting.md。
3. 按 Output 模板向用户报告结果。
Constraints(规则)
- 模板是标准:禁止修改模板目录本身;新库内容必须与模板完全一致,不得增删文件、改配置或改写 AGENTS.md / README.md 治理文件——用户对模板的所有更新都会自动作用于之后新建的库。
- 目标位置已存在同名库时停止并询问用户,不要覆盖。
- 用户要求在 Obsidian 中打开新库时:
open "obsidian://open?path=<新库绝对路径>"。
Output
脚本成功后,按以下格式向用户报告(方括号内为实际值):
✅ 知识库「[知识库名]」已创建:[新库绝对路径]
- 内容与标准模板完全一致([文件数] 个文件):.obsidian 配置 + 3 个插件(tag-wrangler、obsidian-local-images-plus、obsidian-linter)+ AGENTS.md(治理规则)+ README.md + raw/ + wiki/
- 首次在 Obsidian 打开时:点击"信任作者并启用社区插件";库的写入规则见 AGENTS.md(入库/写操作须按其要求执行)
Examples
用户:「帮我建一个叫「读书笔记」的知识库」→ 确认库名齐备,运行脚本后报告:
✅ 知识库「读书笔记」已创建:~/Documents/Obsidian/读书笔记
- 内容与标准模板完全一致(18 个文件):.obsidian 配置 + 3 个插件(tag-wrangler、obsidian-local-images-plus、obsidian-linter)+ AGENTS.md(治理规则)+ README.md + raw/ + wiki/
- 首次在 Obsidian 打开时:点击"信任作者并启用社区插件";库的写入规则见 AGENTS.md(入库/写操作须按其要求执行)
Notes
- 需要了解模板内插件版本、配置细节时才读取
references/template.md,平时不必加载。 - 脚本失败或新库打开异常 →
references/troubleshooting.md;要修改标准模板 →references/update-template.md。 - 修改本 skill 后运行
python3 tests/test.py回归。
Further Reading
- README.md — 使用说明与快速开始
- DESIGN.md — 架构、候选方案与决策记录
- references/template.md — 标准模板详细清单
- CHANGELOG.md — 版本历史
文件结构
| 文件 | 用途 |
|---|---|
| SKILL.md | 触发条件与工作流程 |
| scripts/init_vault.sh | 初始化脚本:校验名字 → 检查重名 → 完整复制 → 完整性验证 |
| tests/test.py | 自动测试:脚本可执行性 + 真实复制冒烟测试 |
| README.md | 使用说明 |
| DESIGN.md | 设计决策记录 |
| references/template.md | 标准模板详细清单(按需查阅) |
| references/troubleshooting.md | 故障排查:退出码对照、失败处理、Obsidian 首开 |
| references/update-template.md | 标准更新指南:改配置、换插件、回归、记录 |
| assets/template/AGENTS.md | 内嵌模板:库治理规则框架(AI 写入前必读) |
| assets/template/README.md | 内嵌模板:库简介(其余为 Obsidian 配置与空内容层,合计 18 项) |
| CHANGELOG.md | 版本历史 |