用途:通过 obsidian 命令行工具与正在运行的 Obsidian 实例交互,进行笔记、任务、属性、标签、反向链接等的读取、创建、搜索与管理,并支持插件与主题的开发调试。使用前需先打开 Obsidian。
基本语法:参数用 = 赋值,含空格的取值加引号,如 obsidian create name="My Note" content="Hello world";布尔开关无值,如 obsidian create name="My Note" silent overwrite。多行内容用 \n 表示换行、\t 表示制表符。运行 obsidian help 可查看全部最新命令,完整文档见 https://help.obsidian.md/cli。
文件与库定位:多数命令接受 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 重载;再运行 obsidian dev:errors 检查错误,若有错则修复后重复;可用 obsidian dev:screenshot path=screenshot.png 截图或 obsidian dev:dom selector=".workspace-leaf" text 检查 DOM 做视觉验证;用 obsidian dev:console level=error 查看控制台输出。其他开发者命令包括 obsidian eval code="app.vault.getFiles().length" 在应用上下文中运行 JavaScript、obsidian dev:css selector=".workspace-leaf" prop=background-color 检查 CSS、obsidian dev:mobile on 切换移动端模拟;运行 obsidian help 可查看含 CDP 与调试器控制的更多开发者命令。
限制:需要正在运行的 Obsidian 实例。资料的官方文档与完整说明未在此提供,具体收费、平台与更多细节暂未提供。