Obsidian Official CLI

💎 官方原生 115 命令全自动化

Obsidian 官方 CLI(v1.12+)完整技能,115 个命令涵盖笔记管理、任务追踪、搜索、数据库、发布、主题插件等全功能自动化,需 Catalyst 许可证。

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

使用说明

核心用法

Obsidian CLI 通过 IPC 与运行中的 Obsidian 实例通信,提供 115 个命令实现知识库全自动化。主要分为六大板块:

内容操作create/read/append/move 等 18 个文件命令支持 Markdown 全生命周期管理;daily 系列自动化日记工作流;unique 生成带时间戳的会议笔记。

知识组织search/search:context 支持正则与上下文检索;tasks/task 管理待办状态;tags/properties 实现元数据驱动;links/backlinks/orphans 维护图谱健康。

高级功能base:* 操作数据库视图;template:* 插入模板;publish:* 需额外订阅($8/月)用于网站发布;sync:* 管理端到端加密同步历史。

环境与扩展theme:*/plugin:* 管理外观与功能;workspace:* 保存加载布局;dev:* 提供 DevTools、JS 执行、截图等调试能力。

显著优点

  • 官方原生:非第三方工具,与 Obsidian 深度集成,稳定性与兼容性最佳
  • 功能完备:覆盖 95% 的 GUI 操作,AI 代理可构建完整自动化工作流
  • 多库支持vault=<name> 参数切换目标库,适合多项目并行
  • 输出灵活:多数命令支持 format=json 便于程序解析
  • 开发者友好:内置 CDP、DOM 查询、移动模拟等专业调试工具

局限与注意事项

  • 平台锁定:仅支持 macOS,Windows/Linux 用户无法使用
  • 付费门槛:需 Catalyst 许可证($25 一次性)解锁 CLI;Publish/Sync 功能另需订阅
  • 运行依赖:Obsidian 必须保持前台运行,无独立守护进程模式
  • 版本要求:1.12+ Early Access 版本,正式版用户需等待更新
  • 无远程能力:纯本地 IPC 通信,无法 SSH 远程操控服务器实例

适合人群

  • 已购买 Catalyst 的 macOS 重度 Obsidian 用户
  • 需自动化日报/周报的职场知识管理者
  • 通过 AI 代理构建个人知识管理系统的开发者
  • 维护大型多库工作流的内容创作者

常规风险

  • 数据安全delete permanent 绕过回收站,自动化脚本误操作可能导致不可逆丢失
  • 同步冲突:多设备同时 CLI 操作可能触发 Sync 版本冲突
  • 插件兼容性plugin:* 命令操作社区插件时,异常插件可能导致 Obsidian 崩溃
  • Eval 风险dev:eval 执行任意 JavaScript,恶意代码可访问完整文件系统
  • 订阅陷阱publish:* 命令在无订阅时静默失败,自动化流程需前置检查

安全解读

核心用法

obsidian-cli-official 是 Obsidian 官方 CLI(v1.12+)的完整命令参考库,提供 115 个命令的结构化文档,涵盖:

| 类别 | 关键命令 | 典型场景 |
|:---|:---|:---|
| 文件管理 | `create` `read` `move` `delete` | 自动化笔记创建与归档 |
| 日记工作流 | `daily` `daily:append` `daily:prepend` | 每日日志自动写入 |
| 知识检索 | `search` `search:context` `outline` | 全文搜索与大纲提取 |
| 任务管理 | `tasks` `task` | 跨文件任务清单聚合与状态切换 |
| 数据库操作 | `base:query` `base:create` | Obsidian Bases(数据库)查询与写入 |
| 版本控制 | `history` `sync:history` `diff` | 本地历史与云端同步版本恢复 |
| 发布工作流 | `publish:add` `publish:status` | Obsidian Publish 内容发布管理 |
| 环境定制 | `theme:set` `plugin:install` `workspace:save` | 主题、插件、工作空间自动化配置 |

执行模式:通过 5 行 Bash 包装脚本设置 PATH 并转发至 /Applications/Obsidian.app/Contents/MacOS/obsidian,依赖 Obsidian 应用的 IPC 接口实际执行。

显著优点

1. 官方权威:直接对应 Obsidian 官方 CLI 实现,命令覆盖度 100%,文档与产品功能同步
2. 自动化就绪:支持多 vault 切换(vault=<name>)、模板插入、属性批量操作,适合构建复杂笔记流水线

3. AI 友好:结构化 Markdown 格式便于 LLM 解析,支持 JSON/CSV 输出格式(format=json)便于程序化处理

4. 开发者工具完备:内置 eval dev:cdp devtools 等 10 个开发调试命令,支持 Chrome DevTools Protocol 与移动设备模拟

潜在局限

  • 平台锁定:macOS 专属,依赖 Catalyst 许可证与本地 Obsidian 1.12+ 安装
  • 运行时依赖:Obsidian 必须保持运行,CLI 通过 IPC 连接,无法独立离线执行
  • 付费功能门槛:Publish/Sync 相关命令需额外订阅($8-96/年)
  • 来源层级:T3 个人开发者维护,非官方 Obsidian 团队直接背书

适合人群

  • Obsidian 重度用户构建个人知识管理自动化工作流
  • 需要批量处理笔记、任务、属性的效率工具爱好者
  • 通过 AI Agent 操作本地知识库的开发者与研究者

常规风险

| 风险点 | 说明 | 缓释措施 |
|:---|:---|:---|
| 代码执行 | `obsidian eval` 可执行任意 JavaScript | 严格验证 `code` 参数,避免注入未信任脚本 |
| 数据误操作 | `delete permanent` `history:restore` 等不可逆 | 关键操作前备份 vault,测试环境先行验证 |
| 版本兼容性 | CLI 接口随 Obsidian 版本迭代可能变更 | 锁定 Obsidian 版本或关注 Skill 更新日志 |
| 平台迁移困难 | 自动化脚本难以迁移至 Windows/Linux | 架构设计时预留跨平台抽象层 |

Obsidian Official CLI 内容

scripts文件夹
手动下载zip · 9.3 kB
obs.shtext/x-shellscript
请选择文件