Obsidian Official CLI

💎 Obsidian 官方命令行,终端掌控知识库

Obsidian 官方 CLI,115+ 命令实现笔记全终端管理,支持文件操作、搜索、任务、属性、链接分析及开发调试,需保持 Obsidian 运行。

收藏
17.5k
安装
3.7k
版本
4.0.2
CLS 安全性认证2026-05-03
点击查看完整报告 >

使用说明

核心用法

Obsidian 官方 CLI 是 Obsidian 1.12+ 内置的命令行工具,通过 IPC 与运行中的 Obsidian 实例通信。支持 115 个命令,覆盖笔记管理的完整生命周期:

文件与内容管理create/read/append/prepend/move/delete 实现程序化笔记操作,支持模板插入和属性读写。

知识网络分析backlinks/links/orphans/deadends/unresolved 提供双向链接拓扑分析,辅助发现知识孤岛和断链。

任务与标签系统tasks 筛选待办,tags counts 统计标签分布,property:set 程序化修改 YAML 属性。

搜索与导航search:context 带上下文搜索,daily 系列快速操作日记,random 随机阅读。

高级功能eval 执行 JavaScript 直接操作 Obsidian API,dev:screenshot 自动化截图,sync/publish 管理云端同步与发布。

显著优点

  • 官方原生:由 Obsidian 团队维护,与编辑器行为完全一致,无第三方解析差异
  • 功能完备:115 个命令覆盖 99% 的日常操作场景,从基础文件到数据库查询
  • 脚本友好--copy 输出剪贴板,\n 支持换行,便于与 Alfred、Raycast、AutoHotkey 集成
  • 跨平台:原生支持 macOS/Windows/Linux,包含 Snap/Flatpak/AppImage 适配

局限与约束

  • 必须运行 GUI:依赖 Obsidian 进程存活,无法纯后台/服务器部署
  • 单实例限制:IPC 通信限制,多开 Obsidian 时行为未定义
  • 无远程能力:仅限本地 vault,不支持 SSH/远程文件系统直接操作
  • 模板依赖template:insert 需配合官方模板插件,社区模板方案不兼容

适合人群

  • 重度键盘用户,追求「不离开终端」的效率极客
  • 需要批量操作笔记的开发者/研究员
  • 构建个人知识管理自动化工作流的高级用户
  • 与 Obsidian Publish/Sync 配合的内容运营者

常规风险

  • 数据安全delete/move 等操作不可逆,建议配合 obsidian sync 版本历史
  • API 稳定性eval 执行 JavaScript 直接操作内部 API,跨版本可能失效
  • 并发问题:CLI 与 GUI 同时修改同一文件可能产生冲突
  • 路径注入path= 参数接受任意文件系统路径,需警惕路径遍历风险

安全解读

核心用法

Obsidian Official CLI Skill 是 Obsidian 官方命令行接口(v1.12+)的完整文档化参考工具,提供 115 个 CLI 命令的结构化查询与使用示例。用户可通过自然语言快速检索命令语法,如创建笔记、搜索全文、管理任务、操作标签与属性、分析链接关系等核心工作流。

显著优点

  • 功能全覆盖:涵盖 Daily Notes、Files、Search、Tasks、Tags、Properties、Links、Sync、Publish、Themes、Plugins、Developer 等 14 个类别,满足从日常笔记到高级自动化的全场景需求
  • 零依赖零风险:纯文档型 Skill,无第三方依赖,无网络调用,数据完全本地处理
  • 官方权威背书:命令文档与 Obsidian 官方 CLI 保持同步,参数与行为准确可靠
  • 跨平台支持:适配 macOS、Windows、Linux 三平台安装路径配置

潜在缺点与局限性

  • 需前置条件:必须安装 Obsidian 1.12+ 并保持运行,需手动启用 CLI 开关
  • 文档滞后风险:Obsidian CLI 更新频繁,Skill 文档可能存在版本延迟
  • 个人维护者:非官方团队维护,长期更新稳定性存疑(T3 来源级别)
  • 无智能补全:仅提供命令查询,无交互式参数提示或自动补全功能

适合人群

  • Obsidian 重度用户,追求键盘驱动的高效笔记工作流
  • 开发者与自动化爱好者,需通过脚本批量操作笔记库
  • 技术写作者,需要快速检索特定命令语法

常规风险

  • 环境配置门槛:PATH 配置错误会导致命令无法识别
  • IPC 连接依赖:Obsidian 未运行时 CLI 无法工作
  • 文件路径混淆file=path= 参数语义差异易引发操作错误

---

> 安全认证结论:S 级(95/100),零外部依赖,无危险代码,可放心使用。

Obsidian Official CLI 内容

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