86 lines
6.6 KiB
Markdown
86 lines
6.6 KiB
Markdown
---
|
||
title: "Obsidian CLI"
|
||
type: source
|
||
tags:
|
||
- "obsidian"
|
||
- "cli"
|
||
- "automation"
|
||
- "skills"
|
||
date: 2026-04-16
|
||
---
|
||
|
||
## Source File
|
||
- [[raw/Skills/Obsidian CLI.md]]
|
||
|
||
## Summary（用中文描述）
|
||
- 核心主题：Obsidian 官方 CLI 命令行工具——从终端完全控制 Obsidian，支持脚本化、自动化和外部工具集成，涵盖日常使用、开发者调试、AI Agent 集成全场景
|
||
- 问题域：笔记操作命令行化、AI Agent 对 Obsidian 的自动化控制、插件与主题开发调试、vault 管理和多端同步
|
||
- 方法/机制：通过 TUI（交互终端界面）或单命令两种模式，以 `obsidian <command>` 语法调用 50+ 内置命令；支持 vault 切换、参数/标志传参、文件定位（file= vs path=）；开发者命令通过 CDP（Chrome DevTools Protocol）实现截图、控制台执行、插件热重载
|
||
- 结论/价值：Obsidian CLI 将 Obsidian 的全部 GUI 功能暴露给命令行，使 AI Agent 可以通过标准化 CLI 接口实现笔记的增删改查、日程管理、搜索、任务操作等，是 AI Agent 操作 Obsidian 知识库的核心基础设施
|
||
|
||
## Key Claims（用中文描述）
|
||
- Obsidian CLI 覆盖了 Obsidian GUI 中的所有功能，任何 GUI 操作均可通过命令行实现
|
||
- Obsidian CLI 需要 Obsidian 1.12.7+ 安装程序，首次使用需在 Settings → General 中启用并注册
|
||
- Obsidian CLI 需要 Obsidian 应用处于运行状态，首条命令会自动启动应用（Headless 同步需另见 Obsidian Headless）
|
||
- TUI 模式支持命令历史、反向搜索（Ctrl+R）和自动补全，适合交互式使用
|
||
- 开发者命令通过 Chrome DevTools Protocol 实现，使 AI Agent 能够自动测试和调试插件和主题
|
||
- Vault 默认使用当前工作目录（如为 vault 文件夹）或当前活跃 vault；可用 `vault=<name>` 或 `vault=<id>` 定向指定
|
||
- 参数（parameter）使用 `key=value` 语法，多词值需引号包裹；标志（flag）为布尔开关，写入即开启
|
||
- 所有命令支持 `--copy` 标志将输出复制到剪贴板
|
||
|
||
## Key Quotes
|
||
> "Anything you can do in Obsidian you can do from the command line. Obsidian CLI even includes developer commands to access developer tools, inspect elements, take screenshots, reload plugins, and more." — Obsidian CLI 官方文档
|
||
> "Obsidian CLI requires the Obsidian app to be running. If Obsidian is not running, the first command you run launches Obsidian." — Obsidian CLI 官方文档
|
||
> "Many developer commands are available for plugin and theme development. These commands allow agentic coding tools to automatically test and debug." — Obsidian CLI 官方文档
|
||
|
||
## Key Concepts
|
||
- [[Obsidian-CLI]]：官方命令行工具，通过终端控制 Obsidian 的全部功能，支持单命令模式和 TUI 交互模式
|
||
- [[Obsidian-TUI]]：交互式终端界面，支持命令历史、自动补全、反向搜索（Ctrl+R）
|
||
- [[Vault-Management]]：vault 切换机制，支持按名称或 ID 定向操作不同笔记库，`vault=<name>` 为首个参数
|
||
- [[Developer-Commands]]：开发者命令组，通过 Chrome DevTools Protocol 实现插件调试、自动化测试
|
||
- [[CDP-Commands]]：Chrome DevTools Protocol 命令集，支持截图、控制台执行、DOM 查询、CSS 检查
|
||
- [[Plugin-Reload]]：插件热重载命令，无需重启应用即可刷新社区插件（`plugin:reload id=<plugin-id>`）
|
||
- [[Daily-Notes-CLI]]：CLI 中的日记命令，支持打开/追加/前置/读取日记内容
|
||
- [[File-Recovery]]：文件历史版本管理，支持 diff 对比和 history 恢复（File Recovery + Sync 双源）
|
||
- [[Base-Commands]]：Bases（数据库视图）相关命令，支持创建、查询（JSON/CSV/TSV/MD 格式输出）
|
||
- [[Property-Commands]]：属性（frontmatter）管理命令，支持设置、读取、删除文件属性
|
||
- [[Task-Commands]]：任务管理命令，支持过滤（todo/done）、每日笔记任务、按文件和状态筛选
|
||
- [[Template-Commands]]：模板命令，支持读取（可解析 {{date}} 等变量）、插入模板到活动文件
|
||
- [[Sync-Commands]]：Obsidian Sync 控制命令，支持暂停/恢复、版本历史查看和恢复
|
||
- [[Plugin-Management-CLI]]：插件管理命令，支持安装/卸载/启用/禁用/重载社区插件
|
||
- [[Publish-Commands]]：Obsidian Publish 命令，支持站点信息、发布状态、增删发布文件
|
||
|
||
## Key Entities
|
||
- [[Obsidian]]：笔记软件开发商，CLI 工具发布方（obsidian.md），要求安装程序版本 1.12.7+
|
||
- [[Obsidian-Skills]]：kepano 发布的 Obsidian Skills 工具链，obsidian-cli 作为官方内置 CLI 在 Skills 项目中被收录（来源：[[obsidian-必装-skills]]）
|
||
|
||
## Connections
|
||
- [[Obsidian-CLI]] ← 依赖 ← [[Obsidian]]（官方内置 CLI，v1.12.7+）
|
||
- [[Obsidian-CLI]] ← 属于 ← [[Obsidian-Skills]]（Skills 工具链之一）
|
||
- [[Obsidian-CLI]] → 支持 → [[AI-Agent-Obsidian-Integration]]（AI Agent 通过 CLI 操作 Obsidian）
|
||
- [[Obsidian-CLI]] → 互补 → [[Claudian]]（Claude Code 插件方案 vs CLI 方案）
|
||
- [[Obsidian-CLI]] → 互补 → [[Obsidian-Agent-Client]]（第三方 Agent 插件方案）
|
||
- [[Obsidian-CLI]] → 互补 → [[Obsidian-Headless]]（CLI 需要桌面应用运行，Headless 用于无头同步）
|
||
|
||
## Command Categories Overview（完整命令分类速查）
|
||
|
||
| 分类 | 主要命令 | 用途 |
|
||
|---|---|---|
|
||
| 日常使用 | `daily`, `search`, `read`, `open`, `tags` | 日记、搜索、读写、标签 |
|
||
| 文件管理 | `create`, `move`, `rename`, `delete`, `append` | 文件增删改移 |
|
||
| 链接管理 | `backlinks`, `links`, `unresolved`, `orphans` | 链接分析 |
|
||
| 任务管理 | `tasks`, `task` | 任务增删改查 |
|
||
| 开发者 | `devtools`, `plugin:reload`, `eval`, `dev:screenshot` | 调试自动化 |
|
||
| 数据管理 | `bases`, `base:create`, `base:query` | 数据库视图 |
|
||
| 同步与历史 | `sync`, `diff`, `history`, `history:restore` | 版本控制 |
|
||
| 插件管理 | `plugins`, `plugin:install`, `plugin:enable` | 插件操作 |
|
||
| 发布 | `publish:add`, `publish:status` | Obsidian Publish |
|
||
| 工作区 | `workspace:save`, `workspace:load`, `tabs` | 工作区管理 |
|
||
|
||
## Contradictions
|
||
- 与 [[obsidian-必装-skills]] 中的 obsidian-cli 描述存在视角差异：
|
||
- 冲突点：obsidian-cli 究竟是"官方 CLI 工具"还是"第三方 Skill"
|
||
- 当前观点（本文档）：obsidian-cli 是 Obsidian 官方内置 CLI（Obsidian.md 出品，v1.12+）
|
||
- 对方观点（obsidian-必装-skills）：将 obsidian-cli 列为 kepano 发布的 Obsidian Skills 之一
|
||
- 分析：两种描述均正确——obsidian-cli 既是 Obsidian 官方内置功能（v1.12+），也是 kepano 在 Skills 项目中收录整理的工具，本质上不矛盾
|