Obsidian 官方命令行界面

Obsidian（v1.12+）的官方命令行界面。包含115个命令。

先决条件

• Obsidian 1.12+（自 v1.12 起为免费公开版本）
• Obsidian 必须处于运行状态（CLI 通过 IPC 连接）
• 启用 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

语法

• 参数:名称=值或名称="带空格的数值"
• 标志: 仅名称，例如打开、覆盖
• 换行符: 在内容字符串中使用\n目标知识库
• :obsidian vault="我的知识库" <命令>（必须位于首位）目标文件
• :file=<文件名>（维基链接风格）或path=<文件夹/文件.md>（精确路径）复制输出
• : 追加--copy--copy任何命令

常用命令（附示例）

每日笔记

obsidian daily                                    # Open today
obsidian daily:append content="- [ ] Buy milk"    # Add to today
obsidian daily:prepend content="# Important"      # Add to top
obsidian daily:read                               # Read today's content
obsidian daily:path                               # Get daily note path

文件

obsidian create name="Note" content="# Hello"     # Create note
obsidian create name="Note" template=Meeting       # Create from template
obsidian read file="Note"                          # Read note
obsidian append file="Note" content="More text"    # Append to note
obsidian prepend file="Note" content="Top text"    # Prepend to note
obsidian move file="Note" to="Archive/Note.md"     # Move note
obsidian rename file="Note" name="New Name"        # Rename note
obsidian delete file="Note"                        # Delete note
obsidian open file="Note"                          # Open note

搜索

obsidian search query="meeting notes"              # Search vault
obsidian search:context query="TODO"               # Search with context
obsidian search:open query="project"               # Open search view

任务

obsidian tasks daily todo                          # Incomplete tasks in daily
obsidian tasks todo                                # All incomplete tasks
obsidian task daily line=3 toggle                  # Toggle task at line 3

标签与属性

obsidian tags counts                               # List all tags
obsidian tags counts sort=count                    # Sort by frequency
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"                    # List all properties

链接

obsidian backlinks file="Note"                     # Incoming links
obsidian links file="Note"                         # Outgoing links
obsidian orphans                                   # No incoming links
obsidian deadends                                  # No outgoing links
obsidian unresolved                                # Broken links

开发者

obsidian devtools                                  # Open dev tools
obsidian eval code="app.vault.getFiles().length"   # Run JavaScript
obsidian dev:screenshot path=screenshot.png         # Screenshot
obsidian plugin:reload id=my-plugin                # Reload plugin

所有命令（共115个）

通用（4个）

• 帮助- 显示帮助 / 特定命令的帮助
• 版本- 显示 Obsidian 版本
• 重载- 重新加载应用窗口
• 重启- 重启应用

每日笔记（5个）

• 每日- 打开每日笔记
• 每日:路径- 获取每日笔记路径
• 每日:读取- 读取每日笔记内容
• 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- 列出知识库中的属性
• 属性:设置- 为文件设置属性
• 属性:移除- 从文件中移除属性
• 属性:读取- 读取属性值

别名 (1)

• 别名- 列出保险库中的别名

链接 (5)

• 反向链接- 列出指向某个文件的反向链接
• 链接- 列出某个文件的外向链接
• 未解析链接- 列出未解析的链接
• 孤立文件- 无内向链接的文件
• 死胡同文件- 无外向链接的文件

大纲 (1)

• 大纲- 显示文件标题

书签 (2)

• 书签- 列出书签
• 书签- 添加书签

基础文件 / 数据库 (4)

• 基础文件- 列出所有基础文件
• 基础文件:视图- 列出基础文件中的视图
• 基础文件:创建- 在基础文件中创建新项目
• 基础文件:查询- 查询基础文件并返回结果

模板 (3)

• 模板- 列出模板
• 模板:读取- 读取模板内容
• 模板:插入- 将模板插入活动文件

命令与快捷键 (4)

• 命令- 列出可用命令ID
• 命令- 执行一个Obsidian命令
• 快捷键- 列出快捷键
• 快捷键- 获取命令的快捷键

标签页与工作区 (7)

• 标签页- 列出打开的标签页
• 标签页:打开- 打开新标签页
• 工作区- 显示工作区树
• 工作区- 列出已保存的工作区
• 工作区:加载- 加载已保存的工作区
• 工作区:保存- 保存当前布局
• 工作区:删除- 删除已保存的工作区

文件历史与差异 (6)

• 差异- 列出或比较本地/同步版本
• 历史记录- 列出文件历史版本
• history:list- 列出有历史记录的文件
• history:read- 读取文件历史版本
• history:restore- 恢复文件历史版本
• history:open- 打开文件恢复功能

同步 (7)

• sync- 暂停或恢复同步（开/关）
• 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- 打开已发布站点

主题与代码片段 (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- 卸载一个社区插件
• 插件：重新加载- 重新加载一个插件

保险库 (3)

• vault- 显示保险库信息
• vaults- 列出已知保险库
• vault:open- 打开一个保险库（仅限TUI）

随机笔记 (2)

• random- 打开一个随机笔记
• random:read- 读取一个随机笔记

唯一笔记 (1)

• unique- 创建唯一笔记

网页查看器 (1)

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

字数统计 (1)

• wordcount- 统计单词和字符数

最近打开 (1)

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

开发者 (10)

• 开发者工具- 切换 Electron 开发者工具
• 执行代码- 执行 JavaScript
• dev:截图- 进行截图
• dev:控制台- 显示捕获的控制台消息
• dev:错误- 显示捕获的错误
• dev:css- 检查带有源码位置的 CSS
• dev:dom- 查询 DOM 元素
• dev:cdp- 运行 Chrome 开发者工具协议命令
• dev:调试- 附加/分离 CDP 调试器
• dev:移动端- 切换移动端模拟

故障排除

"无法连接到 Obsidian"

• 确保 Obsidian 正在运行
• 在设置 → 通用 → 启用 CLI 中启用命令行界面

“未找到命令：obsidian”

• 将 Obsidian 添加到 PATH 环境变量（请参阅上方设置说明）

“文件未找到”

• file=文件名解析方式类似于维基链接（无路径，无 .md 扩展名）
• path=文件夹/文件.md用于指定精确路径

中文说明

前置条件

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

常用命令

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