ben4202121/buddybridge

BuddyBridge

将 Obsidian 连接到 WorkBuddy/CodeBuddy CLI，实现 AI 聊天。

License: MIT

⚠️ 仅支持 Windows。 暂不支持 macOS / Linux。
需要 Obsidian 1.7.2 及以上版本。

BuddyBridge 是一款非官方 Obsidian 插件，用于将你的仓库与本地 WorkBuddy / CodeBuddy CLI 桥接。它会在 Obsidian 内打开一个聊天面板，流式传输 AI 响应，显示思考步骤和工具调用，并在不同会话之间保留你的对话历史。

环境要求

- Obsidian 1.7.2 或更高版本（桌面端）。
- Windows（暂不支持 macOS / Linux）。
- WorkBuddy 桌面应用（≥ 5.0.5），并已安装 CodeBuddy CLI，或在设置中配置自定义 CodeBuddy 路径。

安装

1. 从 latest release 下载 main.js、manifest.json 和 styles.css。
2. 将这三个文件复制到仓库内的 .obsidian/plugins/buddybridge/ 目录中。
3. 重启 Obsidian。
4. 前往 设置 → 第三方插件 → 关闭安全模式 → 启用 BuddyBridge。

首次设置

如果 BuddyBridge 无法自动找到 CodeBuddy 或 Node.js，请按照环境设置提示操作一次（参见下方中文部分，或打开 提示词-发给workbuddy让它给buddybridge授权.md）。

使用方法

1. 点击 机器人侧边栏图标，或从命令面板运行命令 "BuddyBridge: Open chat panel"。
2. 聊天面板会在右侧边栏中打开。
3. 输入消息并按 Enter 发送。使用 Shift + Enter 插入换行。
4. 使用顶部的标签页在对话之间切换，或点击 + 开始新对话。
5. 如有需要，打开 设置 → BuddyBridge 手动配置 CodeBuddy CLI 路径。

功能特性

- Obsidian 侧边栏中的聊天面板，支持多轮对话
- 实时流式响应
- 可折叠的思考块和工具调用卡片
- 助手消息的 Markdown 渲染（代码、表格、列表、引用）
- 仓库感知的上下文注入（自动注入当前笔记路径）
- 当前笔记感知：活动笔记的路径会附加到每条消息中
- 对话在 Obsidian 重启后持久保留
- 在 Windows 上自动发现 CodeBuddy / Node.js 路径
- 可在设置中配置 CLI 路径

故障排除

| 症状 | 原因 | 解决方案 |
|---|---|---|
| Cannot find codebuddy CLI | 自动检测失败 | 在插件设置中填写 CodeBuddy 路径。默认位置：WorkBuddyInstallDir\resources\app.asar.unpacked\cli\bin\codebuddy |
| Cannot find Node.js | Node.js 未配置 | 运行首次环境设置提示（见下方中文部分） |
| 卡在 "Thinking..." | 流式传输结束时没有文本块 | 已在 v1.0.11 中修复 |

中文说明

将 Obsidian 连接到 WorkBuddy/CodeBuddy CLI，实现侧边栏 AI 聊天。

安装

1. 从 latest release 下载 main.js、manifest.json、styles.css。
2. 复制到 Vault 目录下的 .obsidian/plugins/buddybridge/。
3. 重启 Obsidian。
4. 进入 设置 → 第三方插件 → 关闭安全模式 → 开启 BuddyBridge。

使用方法

1. 点击左侧的 机器人图标，或从命令面板运行 “BuddyBridge: 打开聊天面板”。
2. 右侧会打开聊天面板。
3. 输入消息后按 Enter 发送；Shift + Enter 换行。
4. 顶部标签可切换对话，点击 + 新建对话。
5. 如需手动指定 CodeBuddy CLI 路径，进入 设置 → BuddyBridge。

前置条件

1. 已安装 WorkBuddy 桌面版（≥ 5.0.5）
2. 已安装 Obsidian（≥ 1.7.2）

首次使用：环境初始化

如果插件无法自动找到 CodeBuddy 或 Node.js，将以下提示词完整复制到 WorkBuddy 对话中执行一次即可：

请帮我配置 BuddyBridge 插件的运行环境，步骤如下：

1. 搜索 WorkBuddy 安装目录下的 vendor/node.zip（常见位置：C:\Program Files\WorkBuddy、D:\Program Files\WorkBuddy、%LOCALAPPDATA%\Programs\WorkBuddy）

2. 如果 ~/.workbuddy/binaries/node/versions/ 下还没有可用的 node.exe，将 node.zip 里的 node-v-win-x64/ 目录解压，把其中的文件复制到 ~/.workbuddy/binaries/node/versions/{版本号}/（版本号从目录名提取，如 22.22.2）

3. 执行 ~/.workbuddy/binaries/node/versions/{版本号}/node.exe --version 确认可用

4. 可选：同样处理 vendor/PortableGit.zip

完成后告诉我环境是否就绪。

执行完毕后，重启 Obsidian，BuddyBridge 即可正常使用。

功能

- Obsidian 侧边栏聊天面板，支持多轮对话
- 流式输出，实时显示文字
- 可折叠的思考过程与工具调用卡片
- Assistant 消息 Markdown 渲染（代码块、表格、列表、引用）
- 当前笔记感知：发送消息时自动注入当前打开笔记的路径
- 会话管理，重启后恢复对话历史
- CodeBuddy CLI 和 Node.js 路径自动发现
- 设置中可配置 CLI 路径

自动发现

插件启动时自动搜索以下位置：

| 搜索目标 | Windows 路径 |
|----------|-------------|
| WorkBuddy 安装 | %LocalAppData%\Programs\WorkBuddy\...、%ProgramFiles%\WorkBuddy\...、C/D/E 盘全覆盖 |
| npm 全局安装 | %AppData%\npm\codebuddy.cmd、%ProgramFiles%\nodejs\... |
| 系统 PATH | 遍历 PATH 中每个目录查找 codebuddy.cmd / codebuddy.exe |
| WorkBuddy 自带 Node | ~/.workbuddy/binaries/node/versions// |
| 多盘符 Node | C:\Program Files\nodejs、D 盘、E 盘 |

故障排查

| 现象                          | 原因                       | 解决                         |
| --------------------------- | ------------------------ | -------------------------- |
| 找不到 codebuddy CLI         | 自动检测未找到（如自定义安装路径） | 在插件设置中手动填写路径。默认路径：WorkBuddy安装目录\resources\app.asar.unpacked\cli\bin\codebuddy。右键 WorkBuddy 快捷方式 → 打开文件位置 可找到安装目录 |
| 找不到 Node.js 来运行 codebuddy | Node.js 未正确配置            | 完成上方的「环境初始化」               |
| 一直显示「思考中」              | 流式结束未清理占位元素           | 已在 v1.0.11 修复                |
| 重启后对话丢失                 | chatView 未正确持有导致无法加载历史 | 已在 v1.0.11 修复                |

权限授权

插件需要 CodeBuddy 对 Vault 有读写权限才能正常工作。如果使用时提示权限不足，将 提示词-发给workbuddy让它给buddybridge授权.md 的完整内容发送给 WorkBuddy/CodeBuddy 执行一次即可。

完成后完全退出 WorkBuddy/CodeBuddy（系统托盘右键退出），重新打开即可生效。

Settings / 设置

设置页面分为四个部分：

- Connection — CodeBuddy 路径、可选的 Node 路径、CLI 超时时间（秒，默认 300）
- Context injection — 注入当前笔记链接（默认开启）、注入 vault 上下文（默认关闭）
- Appearance — 主强调色
- Management — 最大对话数、导出/导入设置（包括聊天历史、带版本的 JSON）、重置为默认值

| 设置 | 描述 | 默认值 |
| --- | --- | --- |
| CodeBuddy 路径 | CLI 可执行文件路径（留空自动检测） | 自动 |
| Node 路径（可选） | 手动指定 node.exe（留空自动检测） | 自动 |
| CLI 超时时长（秒） | 请求超时后自动终止并提示 | 300 |
| 注入当前笔记链接 | 发送时附加 [当前笔记: 路径] | 开 |
| 注入 Vault 上下文 | 额外附加 [Vault: 路径] | 关 |
| 最大对话数 | 最多保留多少个对话 | 20 |
| 导出/导入设置 | 备份或迁移设置 + 聊天记录（带版本号 JSON） | — |
| 重置为默认 | 恢复默认设置（保留聊天记录，需确认） | — |

开发

npm run dev    # 开发构建
npm run build  # 生产构建
npm test       # 运行测试

许可证

MIT