SuperAPI AI 工具集

obsidian-automation

办公与效率

查看项目

更新于 10-16 05:07

技能介绍

用途:自动化在 Obsidian 图形界面中操作繁琐的重复任务,连接图形界面与命令行、脚本层和外部工具。

主要能力:通过 Obsidian CLI 打开笔记、执行插入模板/导航/切换固定等操作,在不打开 Obsidian 的情况下读取库元数据;批量创建或修改笔记(重命名、更新 frontmatter、按列表创建);库范围搜索与替换;将库内容与其他应用集成;运行定时维护脚本(归档旧笔记、生成索引)。自动化路径包括 Obsidian CLI(经 Local REST API 插件在 localhost:27123 通信)、直接对 .md 文件操作的 shell 脚本,以及 Templater/DataviewJS 插件内置脚本。

使用方式:需在 Obsidian 安装 Local REST API 社区插件并保持 Obsidian 运行,再安装 CLI:npm install -g obsidian-cli(或 npx obsidian-cli --help)。配置 API 密钥:export OBSIDIAN_API_KEY="your-key-here"。核心命令如 obsidian-cli open "Daily Notes/2024-01-15"、get、put、append、search、list、delete。无需 CLI 的任务可直接用 shell 处理 .md 文件。脚本应接受库路径参数、在开头校验参数与环境变量、先做 dry-run、输出每步操作与结果汇总。

适用场景:命令行打开笔记、程序化插入文本或模板、批量处理笔记、集成 shell 脚本/CI/CD、库范围搜索替换、每日本周库维护。

限制与注意:不适用于只需编辑单篇笔记或单篇 frontmatter(应分别直接用文件或 obsidian-frontmatter),也不适用于 wikilink 管理(用 obsidian-links)。CLI 依赖 Local REST API 与 Obsidian 运行;未安装时应改为直接文件操作。禁止未经 dry-run 的破坏性操作,禁止硬编码库路径,禁止改动二进制或非 .md 文件,禁止在版本控制脚本中明文写入 API 密钥。首次批量修改前应备份或在库副本上测试。