Obsidian Agent Client 插件

日本語はこちら

将 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

功能特性

• 笔记引用 (Note Mentions)：通过 @notename 语法引用你的笔记
• 图片附件 (Image Attachments)：支持在聊天中粘贴或拖放图片
• 斜杠命令 (Slash Commands)：使用 Agent 提供的 / 命令
• 多 Agent 支持：可在 Claude Code、Codex、Gemini CLI 及自定义 Agent 之间切换
• 多会话管理：在不同窗口中同时运行多个 Agent
• 悬浮聊天窗口：持久且可折叠的聊天窗口，方便快速访问
• 模式与模型切换：直接在聊天界面更改 AI 模型和 Agent 模式
• 会话历史：恢复或分支（fork）之前的对话
• 对话导出：将对话保存为 Markdown 笔记
• 终端集成：允许 Agent 执行命令并返回结果
• MCP 支持：Agent 直接使用其配置的 MCP 服务器，插件无需额外设置

安装方法

通过社区插件安装（推荐）

1. 打开 设置 (Settings) → 社区插件 (Community Plugins) → 浏览 (Browse)
2. 搜索 "Agent Client"
3. 点击 安装 (Install)，然后点击 启用 (Enable)

通过 BRAT 安装（预览版本）

若想在发布到社区插件库之前尝试预览版本：

1. 安装 BRAT 插件
2. 进入 设置 (Settings) → BRAT → 添加 Beta 插件 (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. 在设置中配置 (设置 → 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. 开始聊天: 点击侧边栏（ribbon）中的机器人图标

设置指南

• 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 趋势