Obsidian CLI

🗂️ 官方 Vault 自动化命令行工具

官方 Obsidian CLI(v1.12+),通过 IPC 连接运行中的 Obsidian 实例,实现 Vault 全自动化管理,支持文件、搜索、任务、属性、链接、工作区、同步、发布等 40+ 功能模块。

收藏
14.1k
安装
3.5k
版本
2.0.0
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

Obsidian CLI 是官方推出的命令行工具,通过 IPC 与运行中的 Obsidian 实例通信,需 Obsidian 1.12+ 并在设置中启用 CLI 功能。基础用法为 obsidian <command> [参数],支持 param=value 语法和 flag 简写。

文件管理create/read/open/move/delete/append/prepend 完整 CRUD,支持模板创建、唯一命名、覆盖控制
搜索:全文检索支持上下文匹配、路径限定、JSON 输出、大小写敏感

任务与标签:提取每日笔记或全局任务,支持状态切换、自定义状态字符;标签统计与按文件查询

属性(Frontmatter):读写 YAML 属性,支持类型转换(date/date-time/list 等)

链接分析:反向链接、孤立文件、死胡同、失效链接检测,支持大纲提取

工作区与标签页:保存/加载布局,标签组管理

历史与同步:本地文件恢复、Obsidian Sync 版本控制

发布:Obsidian Publish 状态检查与批量发布

开发者工具:JS 执行、截图、DevTools、CDP 协议、DOM/CSS 检查、移动模拟

显著优点

  • 官方出品:由 Obsidian 团队维护,与桌面端深度集成,API 稳定性有保障
  • 功能全面:覆盖 95% 的日常 Vault 操作,从笔记管理到发布工作流
  • 脚本友好:支持非交互式调用,适合自动化工作流、CI/CD 集成
  • 多 Vault 支持:通过 vault= 参数或 CWD 自动识别目标库
  • 模板与变量:支持模板解析时注入自定义变量
  • 开发者生态:内置 JS 执行和 CDP,方便插件开发与调试

潜在缺点与局限性

  • 强依赖 GUI:Obsidian 必须处于运行状态,无法纯后台操作(Linux 需处理 IPC/socket 权限)
  • 平台差异:Linux 需 wrapper 脚本避免 Electron flag 冲突;headless/服务场景需额外配置
  • 性能瓶颈folders 命令在 19k+ 文件 Vault 中明显变慢
  • 无远程能力:仅本地 IPC,不支持 SSH 或网络远程管理
  • 权限边界:受限于 Obsidian 运行用户权限,无法突破沙箱

适合人群

  • Obsidian 重度用户,需批量处理笔记、自动化日报/周报生成
  • 知识库管理员,需定期归档、标签清理、链接健康检查
  • 插件开发者,需快速调试、DOM 检查、性能分析
  • 自动化工程师,希望将 Obsidian 纳入现有 CLI 工作流(与 git、ripgrep、fzf 等工具链整合)

常规风险

  • 数据丢失delete permanentrestore 等操作不可逆,脚本中建议先 dry-run
  • 并发冲突:多脚本同时操作同一文件可能产生覆盖,Obsidian 内置冲突解决机制有限
  • 隐私泄露evaldev:console 可执行任意 JS,共享脚本需审计代码
  • 同步状态混乱sync on/off 可能中断正在进行的上传/下载,建议在空闲时段操作
  • 主题/插件变更风险theme:installplugin:install 来源为社区市场,需自行审查

Obsidian CLI 内容

暂无文件树

手动下载zip · 5.5 kB
contentapplication/octet-stream
请选择文件