obsidian-cli

Obsidian CLI

使用 obsidian CLI 与正在运行的 Obsidian 实例交互。需要 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> — 像维基链接一样解析（仅名称，无需路径或扩展名）
• 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 获取计数。

插件开发

开发/测试循环

对插件或主题进行代码更改后，请遵循以下工作流程：

1. 重新加载 插件以应用更改：

   obsidian plugin:reload id=my-plugin
   

2. 检查错误 — 如果出现错误，修复后从步骤 1 重复：

   obsidian dev:errors
   

3. 通过截图或 DOM 检查 进行视觉验证：

   obsidian dev:screenshot path=screenshot.png
   obsidian dev:dom selector=".workspace-leaf" text
   

4. 检查控制台输出 以查看警告或意外日志：

   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 和调试器控制。