使用 Obsidian CLI 通过命令行管理笔记与开发插件
通过 Obsidian CLI 将笔记库的管理权限扩展到终端,实现自动化笔记读写、快速内容搜索,并为插件开发者提供一套无需频繁重启应用的调试工作流。
为什么需要这个技能
对于重度 Obsidian 用户或开发者来说,在 GUI 界面中频繁地创建笔记、修改属性或重新加载插件效率较低。
Obsidian CLI 允许用户直接在 Shell 中与运行中的 Obsidian 实例交互。这意味着你可以编写脚本自动化处理笔记(如每日任务汇总)、通过命令行快速检索信息,或者在开发插件时通过一条命令完成“代码修改
适用场景
- 自动化笔记管理:使用脚本自动创建每日笔记、追加任务清单或批量修改笔记属性。
- 高效内容检索:在终端快速搜索库中特定关键词的内容而无需切换窗口。
- 插件与主题开发:快速重载插件、截取 DOM 结构、检查控制台错误或执行 JS 代码片段进行实时调试。
- 工作流集成:将 Obsidian 的知识库与其他命令行工具(如 zsh/bash 脚本)结合。
核心工作流
1. 基础笔记操作
使用 obsidian 命令配合参数进行操作。注意:必须在 Obsidian 应用运行状态下使用。
- 创建笔记:
obsidian create name="我的笔记" content="Hello world" - 读取内容:
obsidian read file="我的笔记" - 搜索库:
obsidian search query="搜索词" limit=10 - 修改属性:
obsidian property:set name="status" value="done" file="我的笔记"
2. 开发者调试循环
针对插件或主题开发,建议采用以下流水线:
- 重载插件:
obsidian plugin:reload id=my-plugin(立即应用代码变更)。 - 检查错误:
obsidian dev:errors(确认是否存在运行异常)。 - 视觉验证:使用
obsidian dev:screenshot path=screenshot.png快速快照。 - 运行代码:使用
obsidian eval code="app.vault.getFiles().length"在应用上下文中执行 JS。
3. 进阶参数技巧
- 目标定位:使用
file=(支持 Wiki 链接名)或path=(根目录相对路径)。 - 库切换:通过
vault="库名称"指定操作的目标库。 - 静默模式:添加
silent标记可防止操作后自动在 Obsidian 中打开该文件。
下载和安装
解压后将目录放入你的 AI 工具 skills 文件夹,重启工具后即可使用。具体路径参考内附的 USAGE.zh.md。
你可能还需要
暂无推荐