首页 / 开源热榜 / GBrain / 使用教程

GBrain 教程:先做本地 Keyless 记忆回路

更新于 2026-09-23 · 约 10 分钟

GBrain 把可读资料放在 Markdown 和 Git 中,再由 PGLite 或 PostgreSQL 保存索引、事实、修正、任务与账户状态。第一次评估不需要接邮件或远程 MCP,先用虚构数据确认记忆能写入、找回、更正和撤回。

当前版本:v0.51.8.0 发布于 2026-09-22,源码要求 Bun 1.3.11 以上。官方明确提醒:npm 上名为 gbrain 的包与本项目无关。

1. 固定官方版本

git clone --branch v0.51.8.0 --depth 1 https://github.com/garrytan/gbrain.git
cd gbrain
bun install

先核对仓库地址和 tag。快速迭代项目不宜直接跟随默认分支,升级前要阅读 Release 与迁移说明。

2. 建一个本地测试脑库

gbrain init --pglite
gbrain doctor

PGLite 适合单机试用,不用先准备 PostgreSQL。keyless 模式支持关键词检索和代理显式写入;向量、自动抽取、合成与后台整理才需要模型或 embedding 提供方的 key。

3. 验证四步记忆

写入一条虚构事实,记录来源;随后召回它,提交一条修正,再撤回旧结论。检查返回结果是否保留来源和修正链。不要先导入真实邮件、日历或联系人,这些数据集中后会形成新的敏感资产。

4. 选择 MCP 边界

本地 stdio MCP 不需要开放监听端口,适合首次接入。HTTP MCP 属于远程服务面,要配置 HTTPS、OAuth 客户端、read/write/admin 最小范围与速率限制。Tailscale Funnel 也会改变外部可达性,只能显式启用。

5. 备份数据库,而不只是 Git

Markdown 仓库保存可读内容,却不是完整恢复点。事实、修正、持久任务、索引和账户信息还在数据库中。正式导入前先做数据库备份、恢复和删除演练。

与 EverOS 对比

EverOS 也以 Markdown 保存可读记忆,并同步 SQLite/LanceDB;它的最小真实流程需要 LLM key。GBrain 可以先用 PGLite 和关键词检索完成 keyless 流程,并增加来源、修正、撤回、图关系与 MCP 权限。偏好简单 Markdown/API 时可看 EverOS;需要关系图和多代理授权时再评估 GBrain。

验证状态:本轮只核对官方 README、INSTALL、package.json 和 v0.51.8.0 Release。未安装 Bun 或 GBrain,未创建数据库,未接入 MCP、Tailscale、邮件或模型,也未复跑项目方 BrainBench。

这里仅补原教程没有展开的事实和边界。安装命令与操作步骤仍以前文为准。

先判断这个项目是否适合你

适合谁用

适合希望代理跨会话保存来源、修正和实体关系的个人或团队。邮件、日历、联系人和会议导入会集中大量敏感数据;先做最小样本、删除演练、完整数据库备份和逐客户端授权。

原教程未展开的系统信息

核心功能

  • 可追溯记忆

    显式事实保留来源,支持修正和撤回;同一记忆可供多个已授权代理使用。

  • 自织知识图谱

    写入页面时从显式引用提取类型化边,不调用 LLM;图查询可补足纯文本相似度检索。

  • 双存储引擎

    本地小规模可用 PGLite,大规模或多人场景使用 PostgreSQL/pgvector;二者实现同一 BrainEngine 合约。

  • MCP 与后台任务

    支持 stdio/HTTP MCP、OAuth 范围、持久任务和可选夜间整理;远程暴露需要单独配置认证和网络入口。

架构与数据流

Markdown/git 是可读资料层,PGLite 或 PostgreSQL 保存索引、事实、修正、任务和账户数据。BrainEngine 统一引擎操作,CLI 与 MCP 调用同一核心;写入后抽取实体边,搜索可组合关键词、向量、图关系、重排和合成。后台 autopilot 负责同步与整理。

技术栈和运行条件

语言

TypeScript,Bun 1.3.11+

框架

PGLite 或 PostgreSQL/pgvector、MCP SDK、Express、可选模型提供方

关键依赖

  • Git
  • Bun >=1.3.11
  • PGLite 或 PostgreSQL
  • 可选 OpenAI、Anthropic、Voyage 等 API key

运行环境

本地 stdio MCP 可不开放端口;HTTP MCP 需要 OAuth、HTTPS、范围和速率限制

常见问题

GBrain v0.51.8.0 应该从 npm 安装吗?

不应该。官方明确说明 npm 上名为 gbrain 的包与本项目无关,应使用 GitHub 安装路径或源码安装。

GBrain 没有模型 API key 能工作吗?

可以。keyless 模式支持 PGLite、关键词检索和代理显式写入的记忆;向量、自动抽取、合成和后台整理需要另配提供方。

备份 GBrain 的 Markdown 仓库是否足够?

不够。数据库还保存事实、修正、任务和账户数据,官方要求使用完整数据库备份与恢复流程。

GBrain HTTP MCP 可以直接暴露公网吗?

不应直接裸露。需要 HTTPS、OAuth 客户端、最小 read/write/admin 范围、速率限制和受控网络入口;Funnel 也是显式选择。