
关于
使用 Obsidian CLI 读取、创建、搜索和管理知识库内容,或从命令行开发和调试 Obsidian 插件与主题
name: obsidian-cli description: "使用Obsidian CLI读取、创建、搜索和管理仓库内容,或从命令行开发和调试Obsidian插件和主题。" risk: unknown source: "https://github.com/kepano/obsidian-skills" date_added: "2026-03-21"
Obsidian CLI
使用 obsidian CLI与正在运行的Obsidian实例交互。需要Obsidian处于打开状态。
何时使用
- 通过Obsidian CLI管理仓库内容时使用。
- 从命令行开发或调试Obsidian插件和主题时使用。
- 用户需要通过shell与运行中的Obsidian应用交互时使用。
命令参考
运行 obsidian help 查看所有可用命令。始终保持最新。完整文档:https://help.obsidian.md/cli
语法
参数使用 = 赋值。包含空格的值需要加引号:
obsidian create name="My Note" content="Hello world"
标志是无值的布尔开关:
obsidian create name="My Note" silent overwrite
多行内容使用 \n 表示换行,\t 表示制表符。
文件定位
许多命令接受 file 或 path 来定位文件。如果两者都未指定,则使用当前活动文件。
file=<name>— 像wikilink一样解析(仅名称,无需路径或扩展名)path=<path>— 从仓库根目录的精确路径,例如folder/note.md
仓库定位
命令默认定位到最近聚焦的仓库。使用 vault=<name> 作为第一个参数来指定特定仓库:
obsidian vault="My Vault" search query="test"
常用模式
obsidian read file="My Note"
obsidian create name="New Note" content="# Hello" template="Template" silent
obsidian append file="My Note" content="New line"
obsidian search query="search term" limit=10
obsidian daily:read
obsidian daily:append content="- [ ] New task"
obsidian property:set name="status" value="done" file="My Note"
obsidian tasks daily todo
obsidian tags sort=count counts
obsidian backlinks file="My Note"
在任何命令上使用 --copy 将输出复制到剪贴板。使用 silent 防止文件被打开。在列表命令上使用 total 获取计数。
插件开发
开发/测试循环
对插件或主题进行代码更改后,遵循以下工作流程:
- 重新加载插件以应用更改:
obsidian plugin:reload id=my-plugin - 检查错误 — 如果出现错误,修复后从步骤1重复:
obsidian dev:errors - 视觉验证,通过截图或DOM检查:
obsidian dev:screenshot path=screenshot.png obsidian dev:dom selector=".workspace-leaf" text - 检查控制台输出,查看警告或意外日志:
obsidian dev:console level=error
其他开发者命令
在应用上下文中运行JavaScript:
obsidian eval code="app.vault.getFiles().length"
检查CSS值:
obsidian dev:css selector=".workspace-leaf" prop=background-color
切换移动端模拟:
obsidian dev:mobile on
运行 obsidian help 查看其他开发者命令,包括CDP和调试器控制。
限制
- 仅在任务明确匹配上述范围时使用此技能。
- 不要将输出视为环境特定验证、测试或专家审查的替代品。
- 如果缺少必要的输入、权限、安全边界或成功标准,请停下来寻求澄清。
兼容工具
Claude CodeCursor
标签
前端开发