SuperAPI AI 工具集

obsidian-cli

智能体与模型

查看项目

更新于 10-16 03:14

技能介绍

用途:让 Claude 通过官方 Obsidian CLI(v1.12,2026 年 2 月发布)直接与用户的 Obsidian 仓库交互,读取或写入笔记与日记、追加内容、搜索、管理属性与任务等。CLI 通过 IPC 与正在运行的 Obsidian 桌面实例通信。

前提条件:Obsidian 桌面版 v1.12.0+;在设置中开启命令行接口;Obsidian 必须处于运行状态。macOS/Linux 开启后 obsidian 会自动注册到 PATH;Windows 需要 Obsidian.com 重定向文件与 Obsidian.exe 并存,且须用普通用户权限终端(管理员终端会静默失败)。无头 Linux 建议用 .deb 包配合 xvfb,并设置 PrivateTmp=false。

语法:obsidian <command> [subcommand] [key=value ...] [flags],参数用 key=value,含空格的值需加引号。多仓库时把仓库名作为第一个参数,如 obsidian "My Vault" daily:read;省略则作用于最近活跃仓库。

主要能力分组:files(笔记增删改查与文件发现)、daily(日记读写与追加)、search(全文搜索,format=json 返回路径数组)、properties(frontmatter 元数据)、tags、tasks(查询与切换)、links(反向链接、孤立笔记、断链)、bookmarks、templates、plugins、sync、themes、snippets、commands(按 ID 执行命令)、bases、history、workspace、diff、dev(eval、截图、调试)、vault 等,共 130+ 命令。

常用示例:obsidian read path="folder/note.md";obsidian create path="folder/note" content="# New Note";obsidian daily:append content="- [ ] New task";obsidian search query="TODO" path="projects" limit=10;obsidian property:set path="note.md" name="status" value="active";obsidian tasks;obsidian eval code="app.vault.getFiles().length"。无参数运行会进入交互式 TUI。

限制与注意:路径为仓库相对路径;create 省略 .md,move 需含 .md;property:set 的列表值会存为字符串而非 YAML 数组;eval 仅支持单行 JS,多行需写入临时文件;template:insert 只作用于当前活动文件,不接受 path 参数;多仓库指定在某些环境可能报错,可省略仓库名;Windows Git Bash 下冒号子命令可能返回 exit 127,需创建包装脚本或改用非冒号替代命令。

适用场景:日记自动化、按模板建笔记并设置元数据、仓库统计与清理、搜索结果提取供 AI 处理、同步状态检查与版本恢复、执行 Obsidian 命令等。