Obsidian CLI

Obsidian 官方命令行接口。Obsidian 中可执行的任何操作，均可通过命令行完成——包括用于调试、截图和插件重载的开发者命令。

前提条件

• 需 Obsidian 1.12+ 及 Catalyst 许可证
• 设置 → 常规 → 命令行接口 → 启用
• 按提示注册 obsidian 命令
• 重启终端，或在 macOS 上运行 source ~/.zprofile
• 注意：CLI 运行时 Obsidian 必须处于运行状态

验证配置：运行 obsidian version

核心模式

命令结构

# 单条命令
obsidian  [parameters] [flags]

# TUI 模式（交互式）
obsidian  # 进入带自动补全与历史记录的 TUI

# 仓库定位
obsidian vault=Notes 
obsidian vault="My Vault" 

参数类型

• 参数：name=value（含空格的值需加引号）
• 标志（Flags）：布尔开关（仅出现即启用）
• 多行内容：使用 表示换行，t 表示制表符
• 复制输出：添加 --copy 可将结果复制到剪贴板

文件操作

基础文件管理

# 文件信息与列表
obsidian file                          # 当前活动文件信息
obsidian file file=Recipe              # 指定文件信息
obsidian files                         # 列出所有文件
obsidian files folder=Projects/        # 按文件夹筛选
obsidian folders                       # 列出所有文件夹

# 打开与读取
obsidian open file=Recipe              # 打开文件
obsidian open path="Inbox/Note.md" newtab
obsidian read                          # 读取当前活动文件
obsidian read file=Recipe --copy       # 读取并复制到剪贴板

# 创建新笔记
obsidian create name="New Note"
obsidian create name="Note" content="# Title Body"
obsidian create path="Inbox/Idea.md" template=Daily
obsidian create name="Note" silent overwrite

# 修改内容
obsidian append file=Note content="New line"
obsidian append file=Note content="Same line" inline
obsidian prepend file=Note content="After frontmatter"

# 移动与删除
obsidian move file=Note to=Archive/
obsidian move path="Inbox/Old.md" to="Projects/New.md"
obsidian delete file=Note              # 移至废纸篓
obsidian delete file=Note permanent

文件定位方式

• file= —— 使用 Wikilink 解析（按文件名匹配）
• path= —— 从仓库根目录起的精确路径

搜索与发现

文本搜索

obsidian search query="meeting notes"
obsidian search query="TODO" matches    # 显示上下文
obsidian search query="project" path=Projects/
obsidian search query="urgent" limit=10 case
obsidian search query="API" format=json
obsidian search:open query="search term"  # 在 Obsidian 中打开

标签与属性

# 标签
obsidian tags                          # 当前活动文件的标签
obsidian tags all                      # 仓库中全部标签
obsidian tags all counts sort=count    # 按频率排序
obsidian tag name=project              # 标签详情

# 属性（frontmatter）
obsidian properties file=Note
obsidian property:read name=status file=Note
obsidian property:set name=status value=done file=Note
obsidian property:set name=tags value="a,b,c" type=list file=Note
obsidian property:remove name=draft file=Note

链接与结构

# 反向链接与外链
obsidian backlinks file=Note           # 哪些文件链接至此
obsidian links file=Note               # 当前文件的外链

# 仓库分析
obsidian orphans                       # 无入链文件（孤儿文件）
obsidian deadends                      # 无出链文件（死端文件）
obsidian unresolved                    # 断链
obsidian unresolved verbose counts

每日笔记与任务

每日笔记

obsidian daily                         # 打开今日笔记
obsidian daily paneType=split          # 在分栏中打开
obsidian daily:read                    # 输出内容
obsidian daily:append content="- [ ] New task"
obsidian daily:prepend content="## Morning"

任务管理

# 列出任务
obsidian tasks                         # 当前活动文件中的任务
obsidian tasks all                     # 仓库中全部任务
obsidian tasks all todo                # 仅未完成任务
obsidian tasks file=Recipe             # 指定文件中的任务
obsidian tasks daily                   # 每日笔记中的任务

# 更新任务
obsidian task ref="Recipe.md:8" toggle
obsidian task file=Recipe line=8 done
obsidian task file=Recipe line=8 todo
obsidian task file=Note line=5 status="-"  # 自定义状态 [-]

模板与书签

模板

obsidian templates                     # 列出全部模板
obsidian template:read name=Daily
obsidian template:read name=Daily resolve title="My Note"
obsidian template:insert name=Daily    # 插入至当前活动文件
obsidian create name="Meeting Notes" template=Meeting

书签

obsidian bookmarks                     # 列出全部书签
obsidian bookmark file="Important.md"
obsidian bookmark file=Note subpath="#Section"
obsidian bookmark folder="Projects/"
obsidian bookmark search="TODO"
obsidian bookmark url="https://..." title="Reference"

插件与主题管理

插件

# 列出与信息
obsidian plugins                       # 已安装插件列表
obsidian plugins:enabled               # 仅已启用插件
obsidian plugin id=dataview            # 插件详情

# 插件管理
obsidian plugin:enable id=dataview
obsidian plugin:disable id=dataview
obsidian plugin:install id=dataview enable
obsidian plugin:uninstall id=dataview
obsidian plugin:reload id=my-plugin    # 开发用途

主题与 CSS

# 主题
obsidian themes                        # 已安装主题列表
obsidian theme                         # 当前启用主题
obsidian theme:set name=Minimal
obsidian theme:install name="Theme Name" enable

# CSS 片段
obsidian snippets                      # 列出全部片段
obsidian snippet:enable name=my-snippet
obsidian snippet:disable name=my-snippet

高级功能

Obsidian Sync

obsidian sync:status                   # 状态与用量统计
obsidian sync on/off                   # 恢复/暂停同步
obsidian sync:history file=Note
obsidian sync:restore file=Note version=2
obsidian sync:deleted                  # 已删除文件

文件历史

obsidian history file=Note             # 列出版本
obsidian history:read file=Note version=1
obsidian history:restore file=Note version=2
obsidian diff file=Note from=2 to=1   # 版本对比

开发者工具

# 控制台与调试
obsidian devtools                      # 切换开发者工具
obsidian dev:console                   # 显示控制台
obsidian dev:errors                    # JavaScript 错误
obsidian eval code="app.vault.getFiles().length"

# 截图与 DOM
obsidian dev:screenshot path=screenshot.png
obsidian dev:dom selector=".workspace-leaf"
obsidian dev:css selector=".mod-active" prop=background

# 移动端与调试
obsidian dev:mobile on/off
obsidian dev:debug on/off

实用命令

工作区与导航

# 工作区管理
obsidian workspace                     # 当前布局
obsidian workspace:save name="coding"
obsidian workspace:load name="coding"
obsidian tabs                          # 已打开标签页
obsidian tab:open file=Note

# 随机与唯一性操作
obsidian random                        # 打开随机笔记
obsidian random folder=Inbox newtab
obsidian unique                        # 生成唯一名称
obsidian wordcount file=Note           # 字数统计

命令面板

obsidian commands                      # 列出全部命令 ID
obsidian commands filter=editor        # 过滤命令
obsidian command id=editor:toggle-bold
obsidian hotkeys                       # 列出快捷键

TUI 模式

具备增强功能的交互式终端界面：

obsidian                               # 进入 TUI 模式

TUI 快捷键：

• 导航：←/→（Ctrl+B/F），Home/End（Ctrl+A/E）
• 编辑：Ctrl+U（删除至行首），Ctrl+K（删除至行尾）
• 自动补全：Tab/↓（确认），Shift+Tab/Esc（退出）
• 历史记录：↑/↓（Ctrl+P/N），Ctrl+R（反向搜索）
• 其他：Enter（执行），Ctrl+L（清屏），Ctrl+C/D（退出）

故障排查

配置问题

• 请使用最新安装程序（1.11.7+）并开启抢先体验（1.12.x）
• 注册 CLI 后请重启终端
• 使用 CLI 前确保 Obsidian 处于运行状态

平台相关说明

macOS：PATH 已添加至 ~/.zprofile

# 其他 Shell 需手动添加：
export PATH="$PATH:/Applications/Obsidian.app/Contents/MacOS"

Linux：符号链接位于 /usr/local/bin/obsidian

# 如需手动创建：
sudo ln -s /path/to/obsidian /usr/local/bin/obsidian

Windows：需使用 Obsidian.com 终端重定向器（见 Catalyst Discord）