mesalogo
17186b0c11
Magic Notes previously supported rich-text records without a paged drawing or PDF annotation workflow. Add the integrated PeopleLib Fabric and Quill editor with flowing text, pen/highlighter, object transforms, images, paper templates, PDF backgrounds with native text extraction, and raster PDF export. Saves are manual; undo/redo remains scoped to an annotation page or Quill mode. Analyze drafts, saved canvases and canvas-source todos with page images and text when the default model supports images, or an explicitly labelled text-only fallback. Keep successful saves when automatic analysis fails and prevent MCP plain-text replacement of canvas records. Move entry bodies and binary assets into local note files with schema 38 migration and verified readback. SQLite retains metadata, indexes, revisions, todos and comments. Backups must coordinate SQLite and the adjacent notes directory while writes are paused or the app is closed; no one-click backup action is included. Show a continuous record stream with independent collapsible record index and AI pane, real first-page thumbnails, and scroll-only record navigation. Open a blank text/canvas composer by default and reset it after creation. Protect unsaved drafts and establish normalized editor baselines after saving so clean records do not prompt again when leaving. Validation: latest recorded focused run passed 149 tests across five files; typecheck, lint and git diff --check passed. The prior user-reported full run passed 4,713 tests before later corrections and UI changes; it is not a full validation of this final snapshot. Tests were not rerun for this commit, as requested; independent systematic review follows the commit. Release note: Create paged notes with handwriting, flowing text and PDF annotations, browse records through thumbnails, and request AI comments with an explicit text-only fallback. Existing notes migrate to local file storage; backups now need both the database and notes directory.
178 lines
7.3 KiB
Markdown
178 lines
7.3 KiB
Markdown
<div align="center">
|
|
<img src="./sites/assets/goodbuddy-light.png" width="96" alt="GoodBuddy" />
|
|
|
|
# GoodBuddy
|
|
|
|
**Desktop access to model chat, coding agents, knowledge, and scheduled work**
|
|
|
|
**English** | [简体中文](./README.zh-CN.md)
|
|
|
|
[Website](https://mesalogo.github.io/goodbuddy/en.html) ·
|
|
[Download](https://github.com/mesalogo/goodbuddy/releases) ·
|
|
[Feature Matrix](./FEATURES.md) ·
|
|
[Build Guide](./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 is a desktop application for model chat, coding agents, knowledge
|
|
retrieval, notes, and scheduled tasks. No GoodBuddy account is required.
|
|
Workspace data is stored locally by default. Model endpoints can run on the
|
|
same device, on a private network, or at a provider selected by the user.
|
|
|
|
## Highlights
|
|
|
|
- **Local-first workspace**: No GoodBuddy account is required. Workspace data
|
|
stays local by default, and users choose where model services run.
|
|
- **Unified Agent Runtimes**: Use direct models, OpenCode, Continue, and the
|
|
preview DeepSeek Harness from one desktop interface.
|
|
- **Explicit execution boundaries**: `Ask` remains read-only, while `Execute`
|
|
uses the current account's permissions. Tool activity, cancellation,
|
|
timeouts, and token usage are recorded.
|
|
- **Broad platform coverage**: Official Linux releases cover `x64` and `arm64`,
|
|
including compatible distributions used in China's domestic computing
|
|
ecosystem. A separate
|
|
experimental `loong64` preview is available for LoongArch systems.
|
|
- **Knowledge and long-running work**: Knowledge bases, graphs, Magic Notes,
|
|
tasks, and Smart Heartbeat share one desktop workspace.
|
|
|
|
Platform coverage describes operating-system, instruction-set, and package
|
|
compatibility, not certification for every hardware vendor or distribution
|
|
release. LoongArch is outside the official release matrix; see the
|
|
[LoongArch preview notes](./docs/development/loongarch-preview-build.md) for its
|
|
current limitations.
|
|
|
|
## Capabilities
|
|
|
|
| Area | Available in GoodBuddy |
|
|
| --- | --- |
|
|
| Agent Runtimes | Direct model connections, OpenCode, Continue, and the preview DeepSeek Harness |
|
|
| Data and execution | Local SQLite and note-file storage, read-only `Ask`, full-account `Execute`, and recorded tool activity |
|
|
| Knowledge | File, folder, and web imports with full-text, Chinese phrase, vector, and knowledge graph retrieval |
|
|
| Desktop releases | Official Windows, macOS, and Linux builds for `x64` and `arm64`, plus an experimental LoongArch preview |
|
|
| Integrations | Local or hosted model endpoints, custom MCP servers, WeChat ClawBot, WeCom, and DingTalk |
|
|
|
|
## Product tour
|
|
|
|
### Knowledge bases and graphs
|
|
|
|
|
|
|
|
|
|
|
|
### Magic Notes and Smart Heartbeat
|
|
|
|
Magic Notes displays a continuous record stream, with a narrow left index and
|
|
independent right AI comments. Both panes can collapse; thumbnails scroll to a
|
|
record while preserving drafts. It supports rich-text entries and paged canvases with flowing text,
|
|
handwriting, highlights, images and PDF backgrounds. Import PDF text and export
|
|
annotated pages as a raster PDF. Canvas saves are manual; AI comments use the
|
|
default model's image-input capability, with an explicit text-only fallback when
|
|
images are unsupported. See the [Magic Notes documentation](./docs/features/magic-notes/README.md)
|
|
for behavior and final validation status.
|
|
|
|
|
|
|
|
|
|
|
|
## Agent Runtimes
|
|
|
|
| Runtime | Functions | Configuration |
|
|
| --- | --- | --- |
|
|
| Direct models | Chat, retrieval, image generation, and built-in tools | GoodBuddy model connections |
|
|
| OpenCode | Coding agents, native commands, tools, and skills | GoodBuddy-managed or native OpenCode configuration |
|
|
| Continue | Rules, prompt presets, and coding tasks | GoodBuddy-managed or native Continue configuration |
|
|
| DeepSeek Harness (preview) | A fixed host with optional plugin capabilities | GoodBuddy-managed OpenAI-compatible connection |
|
|
|
|
Each run reports cancellation, timeouts, token usage, tool calls, and history.
|
|
Runtime-specific capabilities and configuration remain separate.
|
|
|
|
## Download
|
|
|
|
Download a build from
|
|
[GitHub Releases](https://github.com/mesalogo/goodbuddy/releases):
|
|
|
|
| Platform | Architectures | Formats |
|
|
| --- | --- | --- |
|
|
| Windows | `x64`, `arm64` | NSIS, portable ZIP |
|
|
| macOS | `x64`, `arm64` | DMG, ZIP |
|
|
| Linux | `x64`, `arm64` | AppImage, DEB, RPM |
|
|
|
|
The experimental LoongArch `loong64` build is distributed through a separate
|
|
preview channel on the [product website](https://mesalogo.github.io/goodbuddy/#download).
|
|
|
|
Desktop installers do not contain remote Agent payloads. Local projects do not
|
|
need an Agent package; managed SSH users download or import one explicitly in
|
|
Settings.
|
|
|
|
Code signing and macOS notarization are not configured yet, so the operating
|
|
system may display a security warning.
|
|
|
|
## Run from source
|
|
|
|
Requires Node.js 24 and npm:
|
|
|
|
```bash
|
|
git clone https://github.com/mesalogo/goodbuddy.git
|
|
cd goodbuddy
|
|
npm ci
|
|
npm run dev
|
|
```
|
|
|
|
See [BUILD.md](./BUILD.md) for build and packaging instructions.
|
|
|
|
## Documentation
|
|
|
|
- [Feature matrix and roadmap](./FEATURES.md)
|
|
- [Product feature documentation](./docs/features/)
|
|
- [UI design system](./UI-DESIGN.md)
|
|
- [Build and packaging](./BUILD.md)
|
|
- [Release runbook](./docs/development/release-runbook.md)
|
|
|
|
## Privacy and execution boundaries
|
|
|
|
- Model requests are sent only to services selected by the user.
|
|
- Local data stays in the operating system's application data directory by
|
|
default. API keys are encrypted by secure system storage.
|
|
- The Renderer has no access to raw Electron APIs or model credentials.
|
|
- The DeepSeek Harness plugin marketplace is off by default. Third-party
|
|
install scripts, initialization code, and Execute tools run with the current
|
|
user's permissions.
|
|
- Remote delegation is enabled only after the user configures an endpoint and
|
|
token.
|
|
- Private-network compatibility permits in-app HTTP and non-standard HTTPS
|
|
certificates. WeChat credential and media endpoints remain strictly
|
|
validated.
|
|
|
|
## Contributing
|
|
|
|
Issues and pull requests are welcome. Read [AGENTS.md](./AGENTS.md) first, then
|
|
run:
|
|
|
|
```bash
|
|
npm test
|
|
npm run typecheck
|
|
npm run lint
|
|
```
|
|
|
|
## Community communication
|
|
|
|
Scan the QR code to join the GoodBuddy WeChat group:
|
|
|
|
<img width="1250" height="1743" alt="46b5c3b5936388b0a55db6fe034a7d7f" src="https://github.com/user-attachments/assets/45cd1736-f1ae-4f99-85be-cdb2cc1160c0" />
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
Original GoodBuddy code is released under the [0BSD License](./LICENSE). You may
|
|
use, modify, distribute, and commercialize it freely. Third-party components
|
|
and resources retain their respective licenses.
|