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 可获取计数。

插件和主题开发

在开发或调试 Obsidian 插件或主题之前，请阅读 插件开发，了解完整的重新加载、 错误检查、视觉验证工作流以及开发者命令示例。