Obsidian Official CLI

💎 官方命令行,掌控 115 项笔记能力

笔记工具榜 #1

Obsidian 官方命令行工具,115 个命令覆盖笔记、任务、搜索、属性管理等全功能,需 Catalyst 许可证授权。

收藏
15.8k
安装
3.7k
版本
4.0.1
CLS 安全性认证2026-06-23
点击查看完整报告 >

使用说明

核心用法

Obsidian CLI 是官方推出的完整命令行界面(v1.12+),提供 115 个命令实现无图形界面操作 Obsidian 核心功能。使用前需满足三重要求:Obsidian 1.12+ 版本、Catalyst 许可证($25 一次性购买)、以及启用 CLI 设置。命令通过 IPC 与运行中的 Obsidian 实例通信,因此必须保持应用后台运行。

高频场景obsidian daily 系列管理日记笔记;create/read/append 实现文件 CRUD;search 全文检索;tasks 任务管理;tagsproperties 元数据操作;backlinks/links 链接分析;sync/publish 云服务管理。开发者可通过 eval 直接执行 JavaScript 访问 Obsidian API,devtools 打开 Electron 开发者工具。

参数语法name=value 形式传参,空格值需引号包裹;--copy 标志可将输出复制到剪贴板;vault="Vault Name" 指定目标仓库(必须首位);file=NoteName 使用维基链接解析,path=folder/file.md 使用精确路径。

显著优点

  • 官方原生:由 Obsidian 团队直接维护,与桌面端功能深度集成,无第三方同步延迟或兼容风险
  • 功能全覆盖:115 个命令涵盖笔记管理、任务、搜索、属性、链接分析、主题插件、工作区、历史版本、同步发布等几乎所有 Obsidian 能力
  • 开发者友好:内置 JavaScript 执行、Chrome DevTools Protocol、DOM 查询、截图等调试工具,可直接操作 app 对象
  • 跨平台:支持 macOS/Windows/Linux,Snap/Flatpak/AppImage 均有适配方案

局限性与风险

硬性门槛:Catalyst 许可证 $25 一次性费用将大量用户排除在外;必须保持 Obsidian GUI 运行,无法作为纯后台服务使用;IPC 通信意味着远程 SSH 使用时需配合图形转发。

功能边界:仅操作本地 vault,无法直接管理移动设备笔记;命令输出为纯文本,复杂查询(如 search:context)的可读性不如图形界面;依赖 Obsidian 版本同步更新,旧版本可能命令失效。

潜在风险evaldev:cdp 命令可执行任意代码,共享机器上需防范命令注入;delete/move/sync:restore 等操作不可逆,缺乏交互确认;配置文件权限不当可能导致 vault 路径泄露。

适合人群

  • 重度 Obsidian 用户追求键盘效率,愿意付费解锁高级功能
  • 开发者构建自动化工作流(配合 Alfred/Raycast/Keyboard Maestro)
  • 需要批量处理笔记、生成报告、维护链接健康的进阶用户
  • 主题/插件开发者利用 devtools 快速调试

常规风险等级

安全可控(S级)。官方来源、无网络暴露、本地 IPC 通信,主要风险来自用户自身操作失误或恶意 eval 代码。建议配合 vault 定期备份使用。

安全解读

核心功能

Obsidian CLI Official 是知名知识管理工具 Obsidian 的官方命令行接口(v1.12+)的完整文档封装,提供 115 条命令,实现对 Obsidian 笔记库的全方位终端操控。

核心能力覆盖

  • 日常笔记管理daily 系列命令支持快速打开、追加、预读取今日笔记
  • 文件全生命周期:创建(支持模板)、读取、追加、移动、重命名、删除笔记
  • 智能搜索:全文检索、上下文搜索、直接打开搜索视图
  • 任务管理:列出待办、切换任务状态、按范围筛选
  • 标签与属性:标签频次统计、属性读写、批量操作
  • 链接分析:双向链接查询、孤立页面检测、断链识别
  • 高级功能:数据库查询、工作空间管理、版本历史、同步控制、发布管理、主题/插件管理

技术特性

  • 通过 IPC 与运行中的 Obsidian 实例通信
  • 支持参数化调用(name=value)和标志位
  • 内置 --copy 输出复制能力
  • 开发者工具集成(JS 执行、DOM 查询、截图、调试)

显著优点

1. 官方背书:基于 Obsidian 官方 CLI,功能与主程序深度集成,非第三方逆向方案
2. 功能完备:115 条命令覆盖日常 99% 的笔记操作场景,替代鼠标高频操作

3. 自动化友好:适合构建笔记工作流、配合 cron/Alfred/Raycast 等工具链

4. 双链原生支持:专为 Obsidian 的双向链接设计,file= 参数自动解析 wikilink

5. 零外部依赖:纯文档封装,无额外网络请求或第三方库依赖

潜在局限

1. 许可证门槛:需 Obsidian Catalyst 许可证($25 一次性付费),免费用户无法使用
2. 运行依赖:Obsidian 必须保持运行状态,CLI 本身不独立工作

3. 平台差异:Windows 路径配置相对复杂,Flatpak/AppImage 需额外别名设置

4. T3 来源:封装者为个人开发者,虽内容来自官方,但维护持续性依赖社区

适合人群

  • Obsidian Catalyst 付费用户
  • 习惯终端工作流的效率极客
  • 需要自动化笔记流程的开发者/研究员
  • 构建个人知识管理系统的重度用户

常规风险

  • 数据操作不可逆deletemoverename 等命令无二次确认,建议配合版本控制
  • 同步状态敏感sync 相关命令可能影响云端数据,多人协作 vault 需谨慎
  • JavaScript 执行eval 命令可运行任意代码,需确保输入来源可信

安全评估结论

通过 CLS 六维安全认证(总分 85/100,等级 A):

  • 无危险函数、无敏感信息泄露、无外部依赖、无网络请求
  • 代码功能与声明完全一致,文档型 Skill 特性明显
  • 唯一风险点在于 T3 来源(个人开发者),但内容为官方 CLI 封装,可信度可接受

Obsidian Official CLI 内容

docs文件夹
scripts文件夹
手动下载zip · 16.4 kB
OBSIDIAN_CLI_QUICK_REF.mdtext/markdown
请选择文件