Obsidian 官方命令行工具
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @zcwl/obsidian-official-cli 技能到当前 AI 助手
技能介绍
在Obsidian里做批量笔记重命名、自动化同步检查或插件调试时,逐个点击GUI按钮不仅低效,也难以纳入脚本或CI流程。开发者想在终端复现问题、截取界面截图或快速重载插件,更需要脱离鼠标操作。
核心能力与工作方式
- 文件操作:支持通过
file=参数按Wikilink名称解析文件,或用path=指定库根目录下的精确路径,可执行创建、移动、重命名、删除等操作,多行内容用`
和 转义,--copy`可将输出复制到剪贴板。
- 搜索与内容管理:内置文本搜索、标签与属性筛选,能快速定位笔记;可统计链接结构、生成每日笔记或管理任务清单,也能调用模板插入内容或操作书签。
- 同步与历史:集成Obsidian Sync命令,支持文件历史查看与恢复,方便追踪笔记的变更轨迹。
- 插件与主题:可通过命令行安装、启用、禁用插件,切换主题或修改CSS样式,开发者能用
--reload参数快速重载插件,结合截图命令捕获界面状态。 - TUI模式:提供交互式终端界面,支持光标导航、内容编辑、历史回溯等快捷键,比如用
↑/↓浏览历史命令,Ctrl+R反向搜索,适合需要反复操作的场景。
适用边界与注意点
- 需满足Obsidian 1.12+版本且拥有Catalyst license,需在「设置→通用→命令行接口」中启用,注册
obsidian命令后重启终端(macOS需执行source ~/.zprofile)。 - Obsidian必须处于运行状态,CLI才能正常工作;Windows平台需要通过Obsidian.com提供的终端重定向器(需加入Catalyst Discord获取),Linux平台需确保
/usr/local/bin/obsidian软链接存在。 - 参数值含空格时需用引号包裹,多行内容需用`
`转义,避免因格式错误导致命令执行失败。
使用场景
- 批量重命名笔记时,需要在终端按名称匹配Wikilink,批量修改多篇笔记的文件名
- 调试插件时,需要用CLI执行`obsidian plugin reload`命令,在不重启软件的情况下快速验证改动效果
- 自动化同步笔记后,需要用CLI查看文件历史,快速定位并恢复误修改的文档
- 多笔记内容整理时,需要用CLI调用模板插入每日笔记,统一规范每日记录的格式
适合人员
- Obsidian插件开发者,需要在不重启软件的情况下快速重载插件,验证代码改动是否生效
- 自动化脚本开发者,需要将笔记同步、重命名等操作集成到CI流程,替代手动点击GUI的操作
- 重度笔记用户,每周需要整理上百篇笔记,希望通过命令行批量执行删除、重命名等重复操作
- 跨平台工具开发者,需要在macOS、Linux和Windows终端中统一调用Obsidian命令,适配不同环境的自动化需求