SuperAPI AI 工具集

obsidian-cli

通用与其它

查看项目

更新于 10-15 20:08

技能介绍

用途:通过 obsidian 命令行与正在运行的 Obsidian 实例交互,管理笔记库(vault)中的笔记、任务、属性、标签、反向链接等,并支持插件与主题的开发调试。使用前提是 Obsidian 必须处于打开状态。

主要能力:读取、创建、追加笔记;搜索;日记(daily)读写与追加;设置属性;查询任务与标签;查看反向链接;以及插件重载、错误检查、截图、DOM 检查、控制台查看、执行 JavaScript、检查 CSS、切换移动端模拟等开发者命令。运行 obsidian help 可查看全部命令,完整文档见 https://help.obsidian.md/cli。

用法:参数用 = 赋值,含空格的值需加引号,如 obsidian create name="My Note" content="Hello world";布尔标志不带值,如 silent、overwrite;多行内容用 \n 表示换行、\t 表示制表符。文件定位可用 file=<name>(类似 wikilink,无需路径与扩展名)或 path=<path>(从库根开始的精确路径);不指定则使用当前活动文件。默认作用于最近聚焦的库,可用 vault=<name> 作为首个参数指定库。常见示例:obsidian read file="My Note"、obsidian search query="search term" limit=10、obsidian daily:append content="- [ ] New task"、obsidian property:set name="status" value="done" file="My Note"。任意命令加 --copy 可复制输出到剪贴板,silent 可阻止文件打开,列表命令加 total 可获取计数。

插件开发流程:修改代码后依次执行 obsidian plugin:reload id=my-plugin 重载、obsidian dev:errors 检查错误、obsidian dev:screenshot path=screenshot.png 或 obsidian dev:dom selector=".workspace-leaf" text 验证、obsidian dev:console level=error 查看控制台。

限制:macOS 上首次调用若 Obsidian 未运行会启动 Electron 应用并出现窗口闪烁,之后调用会静默转发参数;交互式工作流(斜杠命令)需在会话开始时确保 Obsidian 已打开;在无法保证 Obsidian 打开的非交互场景(后台钩子、自动化、CI)建议改用文件系统读取方式(Read / Grep / Glob)。