Obsidian CLI

掌控你的仓库。

你在 Obsidian 中能做的任何事,都能通过命令行完成。

终端
# 打开今日日记
obsidian daily

# 搜索你的仓库
obsidian search query="会议记录"

# 向今日日记添加任务
obsidian daily:append content="- [ ] 买菜"

使用场景

Obsidian CLI 是一片面向纯文本的编程游乐场。

开发
更快地构建插件和主题。无需离开终端,即可编辑代码、重新加载、测试和调试。
协作
部署文档,将共享仓库同步到服务器,并将 Obsidian 集成到团队的工具链中。
自动化
使用 cron 任务、shell 脚本和自定义集成来编排你的工作流。只要能写成脚本,就能实现。
试验
以编程方式读取、搜索和写入你的仓库。让智能代理工具能够与你的仓库交互。

快速开始

安装 Obsidian CLI

01

更新 Obsidian

下载最新的 Obsidian 安装程序。 下载 →

02

启用 CLI

设置通用中启用命令行界面

03

注册 CLI

按照屏幕上的说明将 CLI 添加到系统 PATH 中。重启终端以使更改生效。

注册会通过 ~/.zprofile 将 Obsidian 可执行文件添加到你的 PATH 中。如果你使用 bash 或 fish,请手动将该路径添加到你的 shell 配置中。

~/.zprofile
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 内置了便捷的快捷键和自动补全。

导航

向左移动 / Ctrl+B
向右移动 / Ctrl+F
行首 Ctrl+A
行尾 Ctrl+E
前一个单词 Alt+B
下一个单词 Alt+F

编辑

删除到行首 Ctrl+U
删除到行尾 Ctrl+K
删除前一个单词 Ctrl+W / Alt+⌫
接受建议 Tab
关闭建议 Shift+Tab
接受第一条建议

常规

上一条命令 / Ctrl+P
下一条命令 / Ctrl+N
搜索历史记录 Ctrl+R
取消 Escape
清屏 Ctrl+L
退出 Ctrl+C / Ctrl+D

同步

Headless Sync

无需 GUI 运行 Obsidian Sync。在任何服务器或自动化环境中,享受 Obsidian Sync 的速度、隐私和端到端加密。

  • 自动执行远程备份。
  • 自动发布网站。
  • 让智能体工具在无需访问你整台电脑的情况下访问仓库。
  • 将共享团队仓库同步到为其他工具提供数据的服务器。
  • 运行计划自动化——将日记汇总为每周摘要、自动添加标签等。

快速开始

了解如何安装和使用 Obsidian CLI。