mesalogo
2f1881a414
Define repository and feature-scoped documentation rules for PRDs, User Stories, logic, UI, technical design, and progress evidence. Move feature-owned documents under docs/features, add one entry point per feature, remove the redundant docs index, and update all affected cross-references. Expand the local tool environment design with explicit product, story, logic, UI, technical, and progress documents.
107 lines
6.0 KiB
Markdown
107 lines
6.0 KiB
Markdown
# GoodBuddy
|
||
|
||
[English](README.en.md) | 简体中文
|
||
|
||
GoodBuddy是一个开箱即用的 AI 生产平台，安全、跨平台、本地优先的桌面 AI 助手与 Agent 工作空间。
|
||
|
||
产品官网：https://mesalogo.github.io/goodbuddy/
|
||
|
||
五大特点：
|
||
1. 支持国产信创系统和硬件
|
||
2. 免注册，不收集个人信息
|
||
3. 完全开源和免费，友好的OBSD协议
|
||
4. 不需要联网，纯私有网络也可以用
|
||
5. 开放生态，内置主流好用的Agent Runtime，目前支持OpenCode、Continue和DeepSeek Harness，让小白用户也可以快速用起来最前沿的Agent工具
|
||
|
||
|
||
|
||
## 核心能力
|
||
|
||
- **安全执行**：`Ask` 保持只读；`Execute` 仅运行已启用且受边界约束的工具，并保留活动记录。
|
||
- **本地优先**：会话、任务、成果、记忆、知识库和图谱保存在本地 SQLite；API Key 由系统安全存储加密。
|
||
- **多 Runtime**：支持直连模型、OpenCode、Continue 和预览版 DeepSeek Harness，统一处理取消、超时、输出限制和进程退出；原生能力清单将 Tools 与 Commands、LSP、Formatters 分开，并显示来源及 Ask/Execute 可用性。内置 OpenCode 提供 Agent、Tool、Command 与原生 Compact，Continue 提供 Rules、Prompt 预设、结构化提问与 GoodBuddy 手动摘要压缩，并明确标记当前版本无法静态发现原生 Tools。
|
||
- **开放连接**：支持 OpenAI Responses、OpenAI 兼容 Chat Completions、Anthropic Messages、OpenAI Images、Embeddings、跨 Runtime Skills 与自定义 MCP，以及默认关闭、由用户显式开启的 DeepSeek Harness npm 插件市场。Anthropic 连接可独立配置协议必填的单次最大输出，不再复用上下文窗口；OpenAI 直连请求不额外设置输出 Token 上限。MCP 测试可读取有界 Prompt/Resource 元数据，但不会读取 Resource 内容。
|
||
- **知识工作区**：支持文件、目录和网页导入，以及全文、词组、向量和图谱混合检索。
|
||
- **工作管理**：集中管理 Projects、对话、任务、活动、成果、记忆、魔法笔记和智能心跳；可从稳定的本地会话复制当前聊天内容并创建互不影响的会话分支。
|
||
- **远程通道**：支持微信 ClawBot、企业微信和钉钉，每个发送者使用独立远程会话。
|
||
- **托管 SSH 项目（技术预览）**：远程能力默认关闭且不影响普通桌面使用。添加 Host 只保存并探测，不自动安装；Host 卡片以一个按版本事实命名的主按钮准备环境，次级控件可选默认且不持久化的“自动”、Host 下载或 GoodBuddy 传输。自动模式只在操作开始时择一，失败不跨路径重试；两种方式交付同一签名 compound `.gbagent` 后共用 prepare、commit、Agent/Runtime adoption 与 cleanup。项目创建与切换只使用已经准备好的 Host。GitHub/北京镜像、Linux x64/arm64、取消和离线 GoodBuddy 传输的真实 Host 验收仍待完成，当前不表示该路径已发布。
|
||
- **桌面上下文**：可选择文件、截图、应用窗口、剪贴板和语音作为上下文。
|
||
- **离线语音**：支持 SenseVoice、Paraformer 和 Whisper 本地模型。
|
||
- **富文本回答**：支持 Markdown、LaTeX 公式和受控 Mermaid 图表。
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
完整功能和路线图见 [FEATURES.md](FEATURES.md)，产品功能文档位于
|
||
[`docs/features`](./docs/features/)，维护规范见
|
||
[`docs/features/AGENTS.md`](./docs/features/AGENTS.md)。
|
||
|
||
## 安装
|
||
|
||
从 [GitHub Releases](https://github.com/mesalogo/goodbuddy/releases) 下载：
|
||
|
||
| 系统 | 架构 | 格式 |
|
||
| --- | --- | --- |
|
||
| Windows | `x64`、`arm64` | NSIS、便携 ZIP |
|
||
| macOS | `x64`、`arm64` | DMG、ZIP |
|
||
| Linux | `x64`、`arm64` | AppImage、DEB、RPM |
|
||
|
||
桌面安装包不包含远端 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)。
|
||
|
||
## 隐私与安全
|
||
|
||
- 模型请求只发送到用户选择的服务。
|
||
- 本地数据默认保存在系统应用数据目录。
|
||
- Renderer 不接触原始 Electron API 或模型凭据。
|
||
- DeepSeek Harness 插件市场默认关闭；开启并安装第三方插件后，其安装脚本、初始化和 Execute 工具以当前用户权限运行。关闭市场只隐藏目录和管理界面，不会停用或卸载已有插件；安装前会明确确认。Ask 只允许 Host 原生 `read`/`skill` 与 Main 管理的 Web Search/Fetch，不允许调用第三方插件工具，也不能限制插件初始化代码。
|
||
- 远程委派仅在用户配置端点和令牌后启用。
|
||
- 内网兼容模式允许应用内 HTTP 和非标准 HTTPS 证书；微信凭据和媒体端点仍执行严格校验。
|
||
|
||
## 参与贡献
|
||
|
||
欢迎提交 Issue 和 Pull Request。请先阅读 [AGENTS.md](AGENTS.md)，提交前运行：
|
||
|
||
```bash
|
||
npm test
|
||
npm run typecheck
|
||
npm run lint
|
||
```
|
||
|
||
## 为什么选择GoodBuddy
|
||
|
||
<img width="1024" height="1536" alt="6dd45371542dea9fb2d99474387708f5" src="https://github.com/user-attachments/assets/ca608646-ea48-4039-9177-d862be8396ac" />
|
||
|
||
|
||
## 社区交流
|
||
|
||
目前采用微信群的方式供大家高效交流，大家可以微信扫码进入社区群：
|
||
|
||
<img width="1250" height="1743" alt="6ae8664c83b2f182aa81ae94afe691fe" src="https://github.com/user-attachments/assets/10bb7ac2-0bc1-41a9-978d-c2862923fcd6" />
|
||
|
||
|
||
|
||
## 开源许可
|
||
|
||
GoodBuddy 的原创代码采用 [0BSD License](LICENSE)，可自由使用、修改、分发和商用。第三方组件和资源遵循各自许可证。
|