Agent Vault Kit — Obsidian 开箱即用模板
这个仓库把一个实际使用中的 Agent Obsidian Vault 配置整理成了可公开复用的源码插件。核心是自研社区插件 Agent Vault Kit:首次加载时安全应用可移植配置,同时提供纯手动触发的 Cloudflare R2 图片上传。
个人笔记、工作区、最近文件、缓存、索引、个人目录状态、R2 凭据、上传历史和图片元数据均未包含。
开箱内容
- Agent Vault Kit
1.0.0- 源码内置 Obsidian、Make.md、Image Converter 的通用配置。
- 首次加载自动合并配置;改动已有文件前先备份。
- 左侧云上传按钮、
Cmd/Ctrl+Shift+U和命令面板可手动上传当前笔记图片到 R2。 - 不监听文件创建/修改,不自动处理粘贴/拖放,不执行启动扫描。
- Make.md
1.3.5 - ObDrawIO
0.1.3 - Image Converter
1.4.5
插件配置源码见 plugin/agent-vault-kit/profile.ts,实现与 R2 上传源码见 plugin/agent-vault-kit/main.ts。
应用的配置
- 附件保存在当前笔记目录:
attachmentFolderPath: "./"。 - 重命名文件时自动更新链接:
alwaysUpdateLinks: true。 - Agent 使用的核心插件与图谱参数。
- Make.md 的导航、Space、Folder Note、Context 与编辑菜单设置;个人展开目录已清空,Vault 名称已通用化。
- Image Converter 保持原格式、不压缩、质量 100%。
- 社区插件启用清单。
首次应用和手动重新应用配置时,旧文件会备份到:
<Vault>/.obsidian/agent-vault-kit-backups/<timestamp>/
一键安装
目标必须是一个已经存在的 Vault 目录。若目标已有 .obsidian,安装脚本会先把整个目录移动为带时间戳的备份,不会修改笔记。
macOS / Linux
需要 git 和 curl:
git clone https://github.com/CBx-2023/ObsidianVaultTemplate.git
cd ObsidianVaultTemplate
chmod +x scripts/install.sh
./scripts/install.sh "/absolute/path/to/My Vault"
Windows PowerShell
git clone https://github.com/CBx-2023/ObsidianVaultTemplate.git
Set-Location ObsidianVaultTemplate
pwsh -ExecutionPolicy Bypass -File .\scripts\install.ps1 -VaultPath "C:\Notes\My Vault"
--skip-plugin-download / -SkipPluginDownload 会跳过三个第三方插件下载;Agent Vault Kit 本身已包含在模板中。
首次打开 Vault 时,请允许社区插件并完整重启一次。Agent Vault Kit 会优先写入配置,随后 Make.md 与 Image Converter 即可读取这些默认值。
R2 图片上传
R2 凭据不能公开预置。安装后进入 设置 → Agent Vault Kit,填写自己的 Cloudflare Account ID、Access Key ID、Secret Access Key、Bucket 和 Public URL。
配置后可通过:
- 左侧功能区的云上传按钮;
- macOS
Cmd+Shift+U/ Windows、LinuxCtrl+Shift+U; - 命令面板的 “Upload local images in current note”;
- 设置页手动范围扫描。
完整开通步骤见 docs/r2-image-upload.md。
插件开发
cd plugin/agent-vault-kit
npm ci
npm test
npm run build
构建后把 main.js、manifest.json、styles.css 同步到 template/.obsidian/plugins/agent-vault-kit/。发布前运行仓库测试,确认源码配置、模板 JSON 与构建产物一致且不包含凭据。
R2 上传实现基于 fab34 的 cloudflare-media-sync 0.4.1,并保留其 MIT License。Make.md、ObDrawIO、Image Converter 分别适用各自的上游许可。
本仓库主体采用 MIT License。
How to Install
- Download the ZIP or clone the repository
- Open the folder as a vault in Obsidian (File → Open Vault)
- Obsidian will prompt you to install required plugins
Stats
Stars
1
Forks
0
License
MIT
Last updated 17d ago