137 lines
6.5 KiB
Markdown
137 lines
6.5 KiB
Markdown
<div align="center">
|
||
<img src="./sites/assets/goodbuddy-light.png" width="96" alt="GoodBuddy" />
|
||
|
||
# GoodBuddy
|
||
|
||
**模型对话、编程 Agent、本地知识库和定时任务的桌面入口**
|
||
|
||
[English](./README.md) | **简体中文**
|
||
|
||
[产品官网](https://mesalogo.github.io/goodbuddy/) ·
|
||
[下载](https://github.com/mesalogo/goodbuddy/releases) ·
|
||
[功能矩阵](./FEATURES.zh-CN.md) ·
|
||
[构建说明](./BUILD.md)
|
||
|
||
[](https://github.com/mesalogo/goodbuddy/releases)
|
||
[](./LICENSE)
|
||
[](https://github.com/mesalogo/goodbuddy/releases)
|
||
[](https://github.com/mesalogo/goodbuddy/releases)
|
||
[](https://github.com/mesalogo/goodbuddy/releases)
|
||
</div>
|
||
|
||
|
||
|
||
GoodBuddy 是用于模型对话、编程 Agent、知识检索、笔记和定时任务的桌面应用。使用 GoodBuddy 无需注册账号，工作数据默认保存在本机。模型服务可以运行在本机、组织内网或用户选择的云端服务。
|
||
|
||
## 产品亮点
|
||
|
||
- **本地优先**：无需注册 GoodBuddy 账号，工作数据默认保存在本机，模型服务由用户选择。
|
||
- **统一 Agent Runtime**：在一个桌面界面中使用直连模型、OpenCode、Continue 和预览版 DeepSeek Harness。
|
||
- **统一执行**：请求按所选 Runtime、已启用能力和当前账号权限运行，无需选择工作模式；工具调用、取消、超时和 Token 用量均有记录。
|
||
- **支持信创软硬件**：正式 Linux 版本覆盖国产 `x64` 与 `arm64` 架构，可用于统信 UOS、银河麒麟及海光、兆芯、鲲鹏、飞腾等兼容环境；龙芯 LoongArch 提供独立 `loong64` 实验预览版。
|
||
- **知识与长期工作一体化**：知识库、知识图谱、魔法笔记、任务和智能心跳共享同一个桌面工作空间。
|
||
|
||
信创支持按操作系统、指令集和安装包兼容性描述，不代表已完成所有厂商、整机和系统版本的兼容认证。龙芯版本尚未进入正式发布矩阵，具体限制见[龙芯预览版说明](./docs/development/loongarch-preview-build.md)。
|
||
|
||
## 主要能力
|
||
|
||
| 范围 | GoodBuddy 提供的能力 |
|
||
| --- | --- |
|
||
| Agent Runtime | 直连模型、OpenCode、Continue 和预览版 DeepSeek Harness |
|
||
| 数据与执行 | 本地 SQLite 与笔记文件存储、当前账号权限下的工具执行、工具调用记录 |
|
||
| 知识库 | 导入文件、目录和网页，通过全文、中文词组、向量和知识图谱检索 |
|
||
| 桌面版本 | Windows、macOS、Linux 的 `x64` 与 `arm64` 正式版本，以及龙芯 LoongArch 实验预览版 |
|
||
| 外部连接 | 本机或内网模型服务、自定义 MCP、微信 ClawBot、企业微信、钉钉和 Telegram（[真实 Bot 与模型链路待验收](./docs/features/telegram-channel/progress.md)） |
|
||
|
||
## 产品界面
|
||
|
||
### 知识库与知识图谱
|
||
|
||
### 魔法笔记与智能心跳
|
||
|
||
魔法笔记连续展示全部记录，左侧窄栏索引与右侧 AI 评论可独立收起，点击缩略图滚动定位并保留草稿。
|
||
支持富文本记录和分页画布，可混排跨页正文、手写笔迹、高亮、图片与 PDF 底版，
|
||
导入 PDF 时提取原生文字，并将批注页面导出为栅格 PDF。画布由用户手动保存；AI 评论按
|
||
默认模型的图像输入能力分析，不支持图像时明确提示仅文字降级。具体行为与最终验证状态见
|
||
[魔法笔记文档](./docs/features/magic-notes/README.md)。
|
||
|
||
## Agent Runtime
|
||
|
||
| Runtime | 适用场景 | 配置来源 |
|
||
| --- | --- | --- |
|
||
| 直连模型 | 对话、知识检索、图片生成和内置工具 | GoodBuddy 模型连接 |
|
||
| OpenCode | 编程 Agent、原生 Commands、Tools 和 Skills | GoodBuddy 管理或 OpenCode 自有配置 |
|
||
| Continue | Rules、Prompt 预设和编程任务 | GoodBuddy 管理或 Continue 自有配置 |
|
||
| DeepSeek Harness（预览） | 固定 Host 与可选插件能力 | GoodBuddy 管理的 OpenAI 兼容连接 |
|
||
|
||
每次运行都会记录取消、超时、Token 用量、工具调用和执行历史。各 Runtime 的原生能力与配置仍分别管理。
|
||
|
||
## 下载
|
||
|
||
从 [GitHub Releases](https://github.com/mesalogo/goodbuddy/releases) 下载：
|
||
|
||
| 系统 | 架构 | 格式 |
|
||
| --- | --- | --- |
|
||
| Windows | `x64`、`arm64` | NSIS、便携 ZIP |
|
||
| macOS | `x64`、`arm64` | DMG、ZIP |
|
||
| Linux | `x64`、`arm64` | AppImage、DEB、RPM |
|
||
|
||
龙芯 LoongArch 使用独立的 `loong64` 实验预览通道，可在[产品官网](https://mesalogo.github.io/goodbuddy/#download)选择下载。
|
||
|
||
桌面安装包不包含远端 Agent payload。本地项目无需 Agent 包；托管 SSH 用户可在设置中单独下载或导入。
|
||
|
||
当前未配置代码签名和 macOS notarization，操作系统可能显示安全提示。
|
||
|
||
## 从源码运行
|
||
|
||
需要 Node.js 24 和 npm：
|
||
|
||
```bash
|
||
git clone https://github.com/mesalogo/goodbuddy.git
|
||
cd goodbuddy
|
||
npm ci
|
||
npm run dev
|
||
```
|
||
|
||
构建与打包说明见 [BUILD.md](./BUILD.md)。
|
||
|
||
## 文档
|
||
|
||
- [功能矩阵与路线图](./FEATURES.zh-CN.md)
|
||
- [产品功能文档](./docs/features/)
|
||
- [UI 设计系统](./UI-DESIGN.md)
|
||
- [构建与打包](./BUILD.md)
|
||
- [发布流程](./docs/development/release-runbook.md)
|
||
|
||
## 隐私与执行边界
|
||
|
||
- 模型请求只发送到用户选择的服务。
|
||
- 本地数据默认保存在系统应用数据目录，API Key 由系统安全存储加密。
|
||
- Renderer 不接触原始 Electron API 或模型凭据。
|
||
- DeepSeek Harness 插件市场默认关闭。第三方插件安装脚本、初始化代码和工具以当前用户权限运行。
|
||
- 远程委派只在用户配置端点和令牌后启用。
|
||
- 内网兼容模式允许应用内 HTTP 和非标准 HTTPS 证书；微信凭据和媒体端点仍执行严格校验。
|
||
|
||
## 参与贡献
|
||
|
||
欢迎提交 Issue 和 Pull Request。请先阅读 [AGENTS.md](./AGENTS.md)，提交前运行：
|
||
|
||
```bash
|
||
npm test
|
||
npm run typecheck
|
||
npm run lint
|
||
```
|
||
|
||
## 社区交流
|
||
|
||
扫描二维码加入 GoodBuddy 微信群：
|
||
|
||
<img width="1250" height="1743" alt="8d6cd5dc3f347a0f3f1cf3844071b4d3" src="https://github.com/user-attachments/assets/e2cd4874-0b6c-40d4-8867-0a9e843a7cb5" />
|
||
|
||
|
||
|
||
|
||
## 开源许可
|
||
|
||
GoodBuddy 原创代码采用 [0BSD License](./LICENSE)，可自由使用、修改、分发和商用。第三方组件和资源遵循各自许可证。
|