Obsidian 官方 CLI

Obsidian（v1.12+）的官方命令行接口。共 115 个命令。

前置条件

• Obsidian 1.12+（自 v1.12 起为免费公开版本）
• Obsidian 必须正在运行（CLI 通过 IPC 连接）
• 启用 CLI：设置 → 通用 → 启用 CLI

安装配置

将 Obsidian 添加至 PATH：

macOS：

export PATH="$PATH:/Applications/Obsidian.app/Contents/MacOS"

Windows：

$env:PATH += ";$env:LOCALAPPDATA\Obsidian"

Linux：

• Snap：已默认加入 PATH
• Flatpak：alias obsidian='flatpak run md.obsidian.Obsidian'
• AppImage：移至 ~/.local/bin 并执行 chmod +x

验证安装：obsidian version

语法规范

• 参数：格式为 name=value 或 name="value with spaces"
• 标志位（Flags）：仅写名称，例如 open、overwrite
• 换行符：在内容字符串中使用 \n
• 目标仓库（Vault）：obsidian vault="My Vault" （必须置于最前）
• 目标文件：file=（类 Wikilink 风格，不带路径与扩展名），或 path=（精确路径）
• 复制输出：在任意命令末尾添加 --copy

常用命令（附示例）

每日笔记

obsidian daily                                    # 打开今日笔记
obsidian daily:append content="- [ ] Buy milk"    # 向今日笔记追加内容
obsidian daily:prepend content="# Important"      # 向今日笔记顶部插入内容
obsidian daily:read                               # 读取今日笔记内容
obsidian daily:path                               # 获取每日笔记路径

文件操作

obsidian create name="Note" content="# Hello"     # 创建笔记
obsidian create name="Note" template=Meeting       # 使用模板创建笔记
obsidian read file="Note"                          # 读取笔记内容
obsidian append file="Note" content="More text"    # 向笔记末尾追加内容
obsidian prepend file="Note" content="Top text"    # 向笔记开头插入内容
obsidian move file="Note" to="Archive/Note.md"     # 移动笔记
obsidian rename file="Note" name="New Name"        # 重命名笔记
obsidian delete file="Note"                        # 删除笔记
obsidian open file="Note"                          # 打开笔记

搜索

obsidian search query="meeting notes"              # 在仓库中搜索
obsidian search:context query="TODO"               # 搜索并显示上下文行
obsidian search:open query="project"               # 打开搜索视图

任务管理

obsidian tasks daily todo                          # 列出今日笔记中的未完成任务
obsidian tasks todo                                # 列出仓库中所有未完成任务
obsidian task daily line=3 toggle                  # 切换第 3 行的任务状态

标签与属性

obsidian tags counts                               # 列出所有标签
obsidian tags counts sort=count                    # 按出现频次排序
obsidian property:set name="status" value="done" file="Note"
obsidian property:read name="status" file="Note"
obsidian property:remove name="status" file="Note"
obsidian properties file="Note"                    # 列出笔记的所有属性

链接管理

obsidian backlinks file="Note"                     # 查看指向该笔记的入链
obsidian links file="Note"                         # 查看该笔记的出链
obsidian orphans                                   # 列出无入链的笔记
obsidian deadends                                  # 列出无出链的笔记
obsidian unresolved                                # 列出损坏的链接

开发者工具

obsidian devtools                                  # 打开开发者工具
obsidian eval code="app.vault.getFiles().length"   # 执行 JavaScript 代码
obsidian dev:screenshot path=screenshot.png         # 截图
obsidian plugin:reload id=my-plugin                # 重新加载插件

全部命令（共 115 个）

通用命令（4 个）

• help — 显示帮助信息 / 显示特定命令的帮助
• version — 显示 Obsidian 版本号
• reload — 重新加载应用窗口
• restart — 重启应用

每日笔记（5 个）

• daily — 打开每日笔记
• daily:path — 获取每日笔记路径
• daily:read — 读取每日笔记内容
• daily:append — 向每日笔记追加内容
• daily:prepend — 向每日笔记顶部插入内容

文件与文件夹（12 个）

• file — 显示文件信息
• files — 列出仓库中所有文件
• folder — 显示文件夹信息
• folders — 列出仓库中所有文件夹
• open — 打开指定文件
• create — 创建新文件
• read — 读取文件内容
• append — 向文件追加内容
• prepend — 向文件开头插入内容
• move — 移动或重命名文件
• rename — 重命名文件
• delete — 删除文件

搜索（3 个）

• search — 在仓库中搜索文本
• search:context — 搜索并返回匹配行及其上下文
• search:open — 打开搜索视图

任务（2 个）

• tasks — 列出仓库中的任务
• task — 查看或更新某项任务

标签（2 个）

• tags — 列出仓库中的所有标签
• tag — 获取标签详情

属性（4 个）

• properties — 列出仓库中所有属性
• property:set — 为文件设置属性
• property:remove — 从文件中移除属性
• property:read — 读取属性值

别名（1 个）

• aliases — 列出仓库中的所有别名

链接（5 个）

• backlinks — 列出指向某文件的所有入链
• links — 列出某文件的所有出链
• unresolved — 列出所有损坏的链接
• orphans — 列出无入链的文件
• deadends — 列出无出链的文件

大纲（1 个）

• outline — 显示某文件的标题层级结构

书签（2 个）

• bookmarks — 列出所有书签
• bookmark — 添加书签

基座 / 数据库（4 个）

• bases — 列出所有基座文件
• base:views — 列出某基座中的所有视图
• base:create — 在基座中新建条目
• base:query — 查询基座并返回结果

模板（3 个）

• templates — 列出所有模板
• template:read — 读取模板内容
• template:insert — 将模板插入当前活跃文件

命令与快捷键（4 个）

• commands — 列出所有可用命令 ID
• command — 执行一个 Obsidian 内置命令
• hotkeys — 列出所有快捷键绑定
• hotkey — 查询某命令对应的快捷键

标签页与工作区（7 个）

• tabs — 列出当前打开的所有标签页
• tab:open — 新建标签页
• workspace — 显示当前工作区树状结构
• workspaces — 列出所有已保存的工作区
• workspace:load — 加载已保存的工作区
• workspace:save — 保存当前工作区布局
• workspace:delete — 删除已保存的工作区

文件历史与差异比对（6 个）

• diff — 列出或比对本地/同步版本差异
• history — 列出某文件的历史版本
• history:list — 列出具有历史记录的文件
• history:read — 读取某文件的某一历史版本
• history:restore — 恢复某文件的某一历史版本
• history:open — 打开文件恢复界面

同步（7 个）

• sync — 暂停或恢复同步（on/off）
• sync:status — 显示同步状态
• sync:history — 列出同步版本历史
• sync:read — 读取某同步版本
• sync:restore — 恢复某同步版本
• sync:open — 打开同步历史界面
• sync:deleted — 列出同步中已被删除的文件

发布（6 个）

• publish:site — 显示已发布站点信息
• publish:list — 列出已发布的文件
• publish:status — 显示发布状态
• publish:add — 发布指定文件
• publish:remove — 取消发布指定文件
• publish:open — 打开已发布的网站

主题与 CSS 片段（9 个）

• themes — 列出已安装的主题
• theme — 显示当前激活主题或获取主题详情
• theme:set — 设置当前激活主题
• theme:install — 安装社区主题
• theme:uninstall — 卸载主题
• snippets — 列出已安装的 CSS 片段
• snippets:enabled — 列出已启用的 CSS 片段
• snippet:enable — 启用某 CSS 片段
• snippet:disable — 禁用某 CSS 片段

插件（9 个）

• plugins — 列出已安装的插件
• plugins:enabled — 列出已启用的插件
• plugins:restrict — 切换受限模式
• plugin — 获取插件详情
• plugin:enable — 启用插件
• plugin:disable — 禁用插件
• plugin:install — 安装社区插件
• plugin:uninstall — 卸载社区插件
• plugin:reload — 重新加载插件

仓库（3 个）

• vault — 显示当前仓库信息
• vaults — 列出所有已知仓库
• vault:open — 打开仓库（仅限 TUI 界面）

随机笔记（2 个）

• random — 打开一篇随机笔记
• random:read — 读取一篇随机笔记

唯一笔记（1 个）

• unique — 创建唯一命名的笔记

网页查看器（1 个）

• web — 在网页查看器中打开 URL

字数统计（1 个）

• wordcount — 统计字数与字符数

最近打开（1 个）

• recents — 列出最近打开的文件

开发者（10 个）

• devtools — 切换 Electron 开发者工具
• eval — 执行 JavaScript 代码
• dev:screenshot — 截图
• dev:console — 显示捕获的控制台日志
• dev:errors — 显示捕获的错误信息
• dev:css — 带源码位置信息的 CSS 检查
• dev:dom — 查询 DOM 元素
• dev:cdp — 执行 Chrome DevTools Protocol 命令
• dev:debug — 附加/分离 CDP 调试器
• dev:mobile — 切换移动设备模拟模式

故障排查

“无法连接到 Obsidian”

• 确认 Obsidian 正在运行
• 在「设置 → 通用 → 启用 CLI」中开启 CLI 支持

“命令未找到：obsidian”

• 请按上文「安装配置」部分说明，将 Obsidian 添加至系统 PATH

“文件未找到”

• file=Name 按 Wikilink 方式解析（不带路径，不带 .md 扩展名）
• 如需精确路径，请使用 path=folder/file.md

中文说明

前置条件

• Obsidian 1.12+（免费公开版本）
• Obsidian 必须运行中
• 启用 CLI：设置 → 通用 → 启用 CLI

常用命令

obsidian daily                    # 打开今日日记
obsidian create name="笔记"       # 创建笔记
obsidian search query="关键词"    # 搜索
obsidian tasks daily todo         # 列出未完成任务
obsidian tags counts              # 列出标签