Obsidian CLI

🗃️ 官方命令行,掌控你的知识库

Obsidian官方命令行工具,通过IPC连接运行中的Obsidian实例,支持笔记管理、搜索、任务、标签、属性、链接分析及开发者调试等完整功能集

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

使用说明

核心功能

Obsidian CLI 是 Obsidian 1.12+ 官方推出的命令行工具,通过 IPC 与运行中的 Obsidian 实例通信,实现 Vault 的自动化管理。涵盖四大能力域:

1. 笔记与文件操作

支持按名称(维基链接解析)或精确路径读写笔记,提供创建、删除、移动、追加、前置内容等完整生命周期管理,并支持从模板创建笔记。

2. 搜索与任务管理

内置全文搜索(支持上下文匹配、作用域限定、JSON 输出格式),以及强大的任务系统——可提取每日笔记任务、跨 Vault 查询待办事项、切换任务完成状态,并输出详细位置信息。

3. 元数据与图谱分析

提供标签统计、属性读写、双向链接查询、孤儿文件/死胡同文件检测、断链识别及文档大纲提取,助力知识图谱维护。

4. 开发者与多 Vault 支持

支持 JavaScript 代码执行、截图、开发者工具控制、控制台日志及错误捕获;同时原生支持多 Vault 切换(通过 CWD 自动识别或显式指定)。

显著优点

  • 官方出品:与 Obsidian 深度集成,API 稳定性有保障
  • 功能完备:覆盖日常笔记工作流的 90% 以上场景
  • 自动化友好:适合结合 cron、Git Hooks、 Alfred/Raycast 等工具链
  • 多平台:支持 macOS、Windows、Linux(需处理 Electron 标志冲突)

局限性与风险

  • 必须保持 Obsidian 运行:CLI 依赖 IPC,无法独立工作
  • Linux 配置复杂:需处理 Electron 标志注入、systemd 服务的 PrivateTmp 等问题
  • 权限敏感:可执行任意 JavaScript(eval 命令),存在代码注入风险
  • 无远程能力:仅限本地 Vault 操作

适合人群

  • 重度 Obsidian 用户寻求自动化工作流
  • 开发者构建笔记相关的脚本和工具链
  • 需要批量处理笔记元数据的内容管理者

安全提示

obsidian eval 命令可执行任意 JS 代码,避免将用户输入直接传入;建议在受控环境使用,敏感操作前备份 Vault。

安全解读

核心用法

本 Skill 是 Obsidian 1.12+ 官方 CLI 的完整使用指南,并非可执行程序,而是面向开发者和高级用户的命令行参考手册。通过 obsidian 二进制文件与运行中的 Obsidian 实例进行 IPC 通信,实现无需打开 GUI 即可操作笔记库的核心功能。

关键能力覆盖

  • 日常笔记流daily 系列命令支持打开、读取、追加/预置内容到当日笔记
  • 文件操作:支持按名称(wikilink 解析)或精确路径读写、创建、移动、删除笔记
  • 搜索与查询:全文搜索支持上下文展示、路径限定、JSON 输出格式
  • 任务管理:从每日笔记或全库提取待办/已完成任务,支持行级任务状态切换
  • 元数据操作:标签统计、属性读写、反向链接/正向链接分析、孤儿文件检测
  • 开发者工具:JS 代码执行(eval)、截图、DevTools 控制、控制台日志获取
  • 多 vault 支持:自动识别 CWD 所在 vault,或显式指定目标 vault

显著优点

1. 官方背书:直接对接 Obsidian 官方 IPC 协议,非第三方 hack,稳定性与兼容性有保障
2. 自动化友好:完美融入 shell 脚本、Git hooks、定时任务(cron),实现笔记工作流自动化

3. Linux 服务集成:支持 systemd 服务化部署(需注意 PrivateTmp=false 配置)

4. 零网络依赖:纯本地 IPC 通信,无云端同步延迟或隐私泄露风险

5. 模板支持create 命令可直接调用 Obsidian 模板,保持笔记结构一致性

潜在缺点与局限性

1. 必须保持 GUI 运行:Obsidian 实例必须处于运行状态,无法纯后台 CLI 操作
2. Linux 配置复杂:Electron 参数注入问题需 wrapper 脚本规避,增加运维成本

3. 权限边界模糊eval 命令可执行任意 JavaScript,若配合其他自动化工具需警惕代码注入

4. 无远程/多机支持:仅限本地单实例通信,无法直接操作远程服务器上的 vault

5. 版本锁定:功能依赖 Obsidian 1.12+,旧版本用户无法使用

适合人群

  • 重度 Obsidian 用户,追求键盘驱动的工作流
  • 需要将笔记系统与现有开发工具链(git、CI/CD、task runners)集成的开发者
  • 习惯命令行环境、使用 tmux/vim/emacs 作为主力编辑器的效率极客
  • 希望将 Obsidian 作为个人知识库(PKM)后端,构建自定义前端的数据工程师

常规风险

  • IPC 安全:本地 socket 通信通常仅限本机用户,但共享主机或容器环境需注意用户隔离
  • eval 注入obsidian eval 执行未过滤的 JS 代码可能导致 vault 数据损坏,脚本中应严格校验输入
  • 路径遍历path= 参数接受绝对路径,自动化脚本中应避免拼接用户输入
  • 误操作覆盖append/prepend 无确认机制,批量操作前建议先 read 验证目标文件

Obsidian CLI 内容

手动下载zip · 2.3 kB
SKILL.mdtext/markdown
请选择文件