Obsidian CLI
你在 Obsidian 中能做的任何事,都能通过命令行完成。
# 打开今日日记
obsidian daily
# 搜索你的仓库
obsidian search query="会议记录"
# 向今日日记添加任务
obsidian daily:append content="- [ ] 买菜"
使用场景
快速开始
在设置 → 通用中启用命令行界面。
按照屏幕上的说明将 CLI 添加到系统 PATH 中。重启终端以使更改生效。
注册会通过 ~/.zprofile 将 Obsidian 可执行文件添加到你的 PATH 中。如果你使用 bash 或 fish,请手动将该路径添加到你的 shell 配置中。
export PATH="$PATH:/Applications/Obsidian.app/Contents/MacOS"
安装程序会在 Obsidian.exe 旁添加一个 Obsidian.com 终端重定向程序。这是必需的,因为 Obsidian 作为 GUI 应用运行。
AppImage: 会在 /usr/local/bin/obsidian 创建一个符号链接(需要 sudo)。如果 sudo 失败,则回退到 ~/.local/bin。
Flatpak: 会自动创建一个符号链接。如果失败,请手动创建一个指向 Flatpak 导出目录的链接。
安装完成后即可开始使用。请注意,Obsidian 应用必须保持运行。
运行命令
# 显示帮助
obsidian help
使用 TUI 模式
# 打开 TUI(带自动补全)
obsidian
示例
查看实用示例,从日常笔记记录到开发者自动化。
# 打开今日日记
obsidian daily
# 向今日日记添加任务
obsidian daily:append content="- [ ] 买菜"
# 搜索你的仓库
obsidian search query="会议记录"
# 读取当前文件
obsidian read
# 列出今日日记中的所有任务
obsidian tasks daily
# 从模板创建新笔记
obsidian create name="巴黎之旅" template=旅行
# 查看所有标签及其频率
obsidian tags counts
# 比较文件的两个版本
obsidian diff file=README from=1 to=3
# 打开开发者工具
obsidian devtools
# 重新加载开发中的插件
obsidian plugin:reload my-plugin
# 捕获应用截图
obsidian dev:screenshot file=shot.png
# 执行 JavaScript
obsidian eval "app.vault.getFiles().length"
# 查看 JS 错误
obsidian dev:errors
# 检查 CSS 属性
obsidian dev:css selector=".workspace"
# 查询 DOM 元素
obsidian dev:dom selector=".nav"
#!/bin/bash
# 晨间例行自动化
# 打开今日日记
obsidian daily
# 添加例行任务
obsidian daily:append content="- [ ] 查看收件箱"
obsidian daily:append content="- [ ] 查看日历"
# 将最近文件复制到剪贴板
obsidian files sort=modified limit=5 --copy
# 检查未解析链接
obsidian unresolved
# 搜索指定仓库并导出为 JSON
obsidian search query="status::active" vault="笔记" format=json
快捷键
TUI 内置了便捷的快捷键和自动补全。