跳转到内容

CLI 命令(Obsidian CLI)

Sync Vault 在 Obsidian CLI 中注册了 sync-vault: 命名空间下的自定义命令。AI Agent、自动化脚本和高级用户可以通过终端直接操作云盘,无需打开浏览器或插件界面。

  1. Obsidian CLI — 在 Obsidian 中启用:设置 → 通用 → 命令行界面(需要 Obsidian 1.12+ 安装包)。
  2. Obsidian 保持运行 — CLI 命令需要 Obsidian 应用正在运行才能执行。
命令用途主要参数
sync-vault:help显示 CLI 帮助help=true
sync-vault:doctor诊断插件健康状态cloud
sync-vault:info获取账户和存储信息cloud
sync-vault:list列出云盘目录文件path cloud limit offset type minSize modifiedAfter recursive
sync-vault:search搜索云盘文件query cloud limit offset path type
sync-vault:read读取云盘文件内容path cloud maxLength
sync-vault:config查看或修改配置
sync-vault:device管理设备

在终端中使用 obsidian 前缀运行命令:

Terminal window
obsidian sync-vault:list path=/ cloud=aliyun
obsidian sync-vault:search query="会议记录" cloud=baidu
obsidian sync-vault:read path=/笔记.md cloud=quark maxLength=8192
obsidian sync-vault:info cloud=onedrive
obsidian sync-vault:doctor cloud=aliyun

所有子命令支持 help=true 查看详细用法:

Terminal window
obsidian sync-vault:list help=true

列出阿里云盘中的 PDF 文件:

Terminal window
obsidian sync-vault:list path=/Documents cloud=aliyun type=pdf

在夸克网盘中搜索 Markdown 文件:

Terminal window
obsidian sync-vault:search query=obsidian cloud=quark type=markdown

从百度网盘读取文件内容:

Terminal window
obsidian sync-vault:read path=/Notes/Welcome.md cloud=baidu maxLength=4096

这些命令专为 AI Agent 工作流设计。Agent 可以直接运行 CLI 命令来探索和读取云盘文件,无需浏览器或插件 UI。配合 MCP 服务器可实现更深入的功能集成。