SuperAPI AI 工具集

obsidian-cli

通用与其它

查看项目

更新于 10-15 22:39

技能介绍

用途:本技能是 Obsidian 官方 CLI(1.12+)的智能体参考,帮助代理选择使用 CLI 还是普通文件工具。当需要 Obsidian 的索引或应用能力时使用 CLI,例如搜索、反链、链接、标签、任务、属性、Bases、模板、大纲、孤立笔记、未解析链接。简单文件读写、批量文本替换、跨文件 grep 无需应用依赖,使用文件工具(Read/Write/Edit/Grep/Glob)。

语法:obsidian <command> [param=value ...] [flag ...]。可用 vault="My Vault" 指定库,或在库目录内运行。用 path=exact/path.md 指定库相对路径,或 file=name 按链接式解析。含空格的参数值需加引号。flag 为布尔开关,无等号,如 silent、overwrite、counts、total。内容字符串中用 \n 换行、\t 制表。结构化输出用 format=json(search、base:query)或 format=tsv(properties、tags),追加 --copy 可复制输出。

主要命令:读写方面有 read、append、prepend、create、move、delete。create 加 silent 才会在应用 UI 外静默创建;不加 silent 会在 Obsidian 界面打开文件。create 不会自动建目录,需先用 mkdir -p。create 使用 template= 时可能放入模板配置的文件夹而忽略 path=,创建后需核实实际路径。daily 系列含 daily、daily:read、daily:append、daily:prepend。属性前端字段有 property:set、property:read、property:remove、properties。搜索用 search query=,可加 path=、limit=,format=json matches 返回含行号的结构化结果。标签与任务含 tags、tag、tasks、task,tags all counts 列出全库标签计数,tasks all todo/done 列全库任务,task ref=toggle 切换任务状态。链接与图谱含 backlinks、links、unresolved、orphans、deadends。结构含 files、folders、outline。Bases 含 bases、base:query。模板含 templates、template:read。诊断用 vault 和 version。

限制与安全:CLI 需要 Obsidian 桌面应用正在运行,否则命令会挂起或超时;版本过低会出现 Unknown command。索引未就绪时搜索或标签可能返回空结果。未获用户明确请求时,不应运行 eval、delete permanent、plugin:install/uninstall、dev:cdp。优先使用 append/prepend 而非整文件覆盖,create 不加 overwrite 是安全的;批量属性修改、移动或删除文件前应先与用户确认。CLI 不可用时回退到 Read/Write/Edit/Grep/Glob。