obsidian-cli

Obsidian CLI

使用 obsidian CLI 与正在运行的 Obsidian 实例交互。需要 Obsidian 处于打开状态。

重要

macOS — 使用 CLI 前先打开一次 Obsidian。 在 macOS 上，如果没有 Obsidian 实例正在运行，obsidian 命令会启动 Electron 应用，首次调用时会短暂显示窗口。Obsidian 打开后，后续 CLI 调用会静默地将参数转发给正在运行的实例，不会再闪烁。对于交互式工作流（斜杠命令），请确保在会话开始时 Obsidian 已打开。对于无法确保 Obsidian 已打开的非交互式场景（后台钩子、自动化、CI），建议通过 Read / Grep / Glob 读取文件系统。

命令参考

运行 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 和调试器控制命令。