跳到主要内容

GBrain 快速入门指南

GBrain 是什么? 它是一个个人/团队知识库的"大脑"层。搜索给你页面,GBrain 给你答案。


一、核心概念(5 分钟理解)

1.1 它解决了什么问题?

传统笔记/搜索工具的问题:

  • 给你一堆页面链接,需要你自己阅读整理
  • 关键词匹配,但不理解语义
  • 无法回答跨页面的复杂问题

GBrain 的不同:

  • 直接给你答案,带引用来源
  • 理解实体关系(谁在哪个公司、谁投资了什么)
  • 自动提取结构化事实
  • 告诉你"大脑还不知道什么"(缺口分析)

1.2 核心架构

你的知识(Markdown 文件) → GBrain 大脑 → 问答/搜索/分析

PGLite/Postgres(存储 + 向量)

AI 技能(60+ 可调用能力)

1.3 两个关键概念

Brain(大脑) = 一个数据库

  • 可以有一个个人大脑
  • 可以挂载多个团队大脑

Source(来源) = 大脑内的一个仓库

  • 个人大脑可以有多个 source(wiki、gstack、openclaw 等)
  • 每个 source 是一个独立的内容仓库

简单理解:默认情况下你只用一个大脑 + 一个 source,不需要纠结这个概念。


二、快速安装(30 分钟)

2.1 前置要求

  • 已安装 Bun(如果没安装:curl -fsSL https://bun.sh/install | bash
  • API 密钥(至少需要):
    • OpenAI API Key(用于嵌入)
    • Anthropic API Key(用于 Claude 模型)

2.2 安装步骤

# 1. 安装 GBrain CLI
bun install -g github:garrytan/gbrain

# 2. 初始化大脑(使用 PGLite,无需服务器,2 秒完成)
gbrain init --pglite

# 3. 配置 API 密钥
gbrain config set openai_api_key sk-...
gbrain config set anthropic_api_key sk-ant-...

# 4. 验证安装
gbrain doctor

2.3 导入你的知识

# 批量导入一个 Markdown 文件夹
gbrain import ~/my-knowledge

# 或者实时同步一个 Git 仓库
gbrain sync --watch

三、基础使用(10 分钟)

3.1 提问

# 基础问答
gbrain query "Alice 是做什么的?"

# 带上下文的复杂问题
gbrain query "我下周和 Alice 开会需要准备什么?"

# 指定来源(如果有多 source)
gbrain query "X" --source wiki

3.2 典型输出

Alice 负责 Acme 的工程管理(一家 A 轮融资的 fintech 公司)。
你们上次交谈是在 4 月 22 日,讨论定价问题。

三个待办事项:
1. 她需要给你安全审查报告(截止日期 5 月 1 日,未更新)
2. 你承诺提供 500 人席位的定价(4 月 25 日发送,未回复)
3. 她提到在招聘 CISO,你答应介绍人脉

注意:自 4 月 22 日后大脑没有关于 Alice 或 Acme 的新内容。
她可能通过邮件或 Slack 回复了,这些渠道大脑看不到。

3.3 常用命令

# 查看配置
gbrain config show

# 列出所有页面
gbrain list

# 查找谁知道某个信息
gbrain whoknows "Q3 路线图讨论"

# 导出知识
gbrain export --format markdown

# 升级 GBrain
gbrain upgrade

四、进阶功能(按需学习)

4.1 使用 MCP 客户端

如果你使用 Claude Desktop、Cursor 等支持 MCP 的工具:

# 启动 MCP 服务器(stdio 模式)
gbrain serve

# 或者 HTTP 模式(带 OAuth)
gbrain serve --http

然后在你的 MCP 客户端配置中添加 GBrain 服务器。

4.2 自定义 Schema(结构化知识)

默认 schema 有 22 种页面类型(人、公司、会议等)。你可以添加自己的类型:

# 创建自定义 schema
gbrain schema fork gbrain-base mine
gbrain schema use mine

# 添加新类型(例如研究者)
gbrain schema add-type researcher \
--primitive entity \
--prefix people/researchers/ \
--expert

# 添加类型关系
gbrain schema add-link-type authored \
--page-type researcher \
--target-type paper

# 应用 schema(自动回填现有页面)
gbrain schema sync --apply

4.3 使用技能系统

GBrain 有 60+ 内置技能,你的 AI Agent 可以直接调用:

# 安装所有技能包
gbrain skillpack scaffold --all

# 查看已安装的技能
ls skills/

4.4 团队大脑

如果你想和团队共享大脑:

# 挂载团队大脑
gbrain mounts add team-brain \
--path ~/team-brains/eng \
--db-url postgres://...

# 在团队目录中自动切换到团队大脑
echo "team-brain" > ~/team-brains/eng/.gbrain-mount

五、典型应用场景

5.1 会议准备

问:"明天和 Alice 的会议需要准备什么?"
→ 大脑返回:她的职位、上次谈话要点、待办事项、缺口信息

5.2 研究总结

问:"总结我们关于缓存优化的所有讨论"
→ 大脑跨页面合成答案,带引用

5.3 关系查询

问:"谁介绍了我认识 Bob?"
→ 大脑遍历关系图找到答案

5.4 事实提取

问:"Acme 的 MRR 是多少?"
→ 大脑从结构化事实中提取,而非文本匹配

六、进阶阅读


七、常见问题

Q: PGLite 和 Postgres 怎么选?

  • < 1000 个文件:PGLite(无需服务器,2 秒启动)
  • 1000 个文件或团队协作:Postgres + Supabase

Q: 需要多少 API 调用?

  • 查询:取决于复杂度,通常 1-3 次
  • 事实提取:仅在写入时触发
  • 推荐:使用 ZeroEntropy 作为嵌入(更快更便宜)

Q: 数据安全吗?

  • 所有数据存储在本地/你控制的数据库
  • API 密钥只用于嵌入和推理
  • 团队大脑有访问控制

Q: 能和现有笔记工具集成吗?

  • 可以导入任何 Markdown 文件夹
  • 支持实时同步 Git 仓库
  • 可以作为 MCP 服务器供其他工具调用

文档来源:基于 GBrain 官方文档整理