goodbuddy/README.md

GoodBuddy

English | 简体中文

安全、跨平台、本地优先的桌面 AI 助手与 Agent 工作空间。

核心能力

• 安全执行：Ask 保持只读；Execute 仅运行已启用且受边界约束的工具，并保留活动记录。
• 本地优先：会话、任务、成果、记忆、知识库和图谱保存在本地 SQLite；API Key 由系统安全存储加密。
• 多 Runtime：支持直连模型、OpenCode 和 Continue，统一处理取消、超时、输出限制和进程退出。
• 开放连接：支持 OpenAI Responses、OpenAI 兼容 Chat Completions、Anthropic Messages、OpenAI Images、Embeddings、Skills 和 MCP。
• 知识工作区：支持文件、目录和网页导入，以及全文、词组、向量和图谱混合检索。
• 工作管理：集中管理 Projects、对话、任务、活动、成果、记忆、魔法笔记和智能心跳。
• 远程通道：支持微信 ClawBot、企业微信和钉钉，每个发送者使用独立远程会话。
• 桌面上下文：可选择文件、截图、应用窗口、剪贴板和语音作为上下文。
• 离线语音：支持 SenseVoice、Paraformer 和 Whisper 本地模型。
• 富文本回答：支持 Markdown、LaTeX 公式和受控 Mermaid 图表。

完整功能和路线图见 FEATURES.md。

安装

从 GitHub Releases 下载：

系统	架构	格式
Windows	x64、arm64	NSIS、便携 ZIP
macOS	x64、arm64	DMG、ZIP
Linux	x64、arm64	AppImage、DEB

当前尚未配置代码签名和 macOS notarization，系统可能显示安全提示。

从源码运行

需要 Node.js 24 和 npm：

git clone https://github.com/mesalogo/goodbuddy.git
cd goodbuddy
npm ci
npm run dev

构建与打包说明见 BUILD.md。

隐私与安全

• 模型请求只发送到用户选择的服务。
• 本地数据默认保存在系统应用数据目录。
• Renderer 不接触原始 Electron API 或模型凭据。
• 远程委派仅在用户配置端点和令牌后启用。
• 内网兼容模式允许应用内 HTTP 和非标准 HTTPS 证书；微信凭据和媒体端点仍执行严格校验。

参与贡献

欢迎提交 Issue 和 Pull Request。请先阅读 AGENTS.md，提交前运行：

npm test
npm run typecheck
npm run lint

开源许可

GoodBuddy 的原创代码采用 0BSD License，可自由使用、修改、分发和商用。第三方组件和资源遵循各自许可证。