Obsidian Agent Client 插件

日本語はこちら

通过 Agent Client Protocol (ACP) 将 AI Agent（如 Claude Code、Codex 和 Gemini CLI）直接引入 Obsidian。让你在笔记库（Vault）中即可与 AI 助手进行对话。

基于 Zed 开发的 Agent Client Protocol (ACP) 构建。

https://github.com/user-attachments/assets/1c538349-b3fb-44dd-a163-7331cbca7824

功能特性

• 笔记引用：使用 @notename 语法引用你的笔记
• 图片附件：在聊天中粘贴或拖放图片
• Slash 命令：使用由 Agent 提供的 / 命令
• 多 Agent 支持：在 Claude Code、Codex、Gemini CLI 及自定义 Agent 之间切换
• 多会话：在不同视图中同时运行多个 Agent
• 悬浮聊天窗口：持久、可折叠的聊天窗口，方便快速访问
• 模式与模型切换：直接在聊天中更改 AI 模型和 Agent 模式
• 会话历史：恢复或分支（Fork）之前的对话
• 聊天导出：将对话保存为 Markdown 笔记
• 终端集成：允许 Agent 执行命令并返回结果

安装指南

通过 BRAT 安装（推荐）

1. 安装 BRAT 插件
2. 前往 Settings → BRAT → Add Beta Plugin
3. 粘贴地址：https://github.com/RAIT-09/obsidian-agent-client
4. 在插件列表中启用 Agent Client

手动安装

1. 从 Releases 下载 main.js、manifest.json 和 styles.css
2. 将它们放入 VaultFolder/.obsidian/plugins/agent-client/ 文件夹中
3. 在 Settings → Community Plugins 中启用该插件

快速上手

打开终端（macOS/Linux 为 Terminal，Windows 为 PowerShell）并运行以下命令：

1. 安装 Agent 及其 ACP 适配器（以 Claude Code 为例）：

   curl -fsSL https://claude.ai/install.sh | bash   # 安装 Claude Code
   npm install -g @agentclientprotocol/claude-agent-acp   # 安装 ACP 适配器
   

2. 登录（如果使用 API Key 可跳过此步）：

   claude
   

   按照提示使用你的 Anthropic 账户进行身份验证。

3. 查找路径：

   which node   # macOS/Linux
   which claude-agent-acp
   
   where.exe node   # Windows
   where.exe claude-agent-acp
   

4. 在设置中配置：前往 Settings → Agent Client：

   • Node.js path：例如 /usr/local/bin/node
   • Built-in agents → Claude Code → Path：例如 /usr/local/bin/claude-agent-acp（注意不是 claude）
   • API key：填入你的 Key，如果已通过 CLI 登录则可留空

5. 开始聊天：点击侧边栏的机器人图标即可开始

设置指南

• Claude Code
• Codex
• Gemini CLI
• 自定义 Agent (OpenCode, Qwen Code, Kiro, Mistral Vibe 等)

完整文档

开发

npm install
npm run dev

生产环境构建：

npm run build

许可证

Apache License 2.0 - 详见 LICENSE 文件。

Star 历史