OmniMem（中文说明）

English: README.md

OmniMem 是一套可复用、低耦合的 AI Agent 记忆基础设施，支持跨工具、跨设备、跨项目与跨账号。

3 分钟上手

1. 安装：

bash scripts/install.sh

2. 启动 WebUI + 守护进程：

~/.omnimem/bin/omnimem start

3. 打开：

• http://127.0.0.1:8765

4. 在 WebUI 完成 GitHub 同步登录（可选）：

• Configuration -> GitHub Quick Setup -> Sign In via GitHub。

OAuth Broker 一键部署

部署完成后，把 broker URL 填到 WebUI Configuration -> OAuth Broker URL。 说明：Cloudflare 可能先展示通用 monorepo 警告页面，这属于正常提示，可继续操作。

部署页面需要填写的关键项：

• Cloudflare Worker：
  • Variables/Secrets 中设置 GITHUB_OAUTH_CLIENT_ID。
• Vercel：
  • Environment Variables 增加 GITHUB_OAUTH_CLIENT_ID（至少 Production）。
• Railway：
  • Variables 增加 GITHUB_OAUTH_CLIENT_ID。
• Fly.io：
  • App 名称可自定义且需唯一。
  • 设置 secret：fly secrets set GITHUB_OAUTH_CLIENT_ID=...。

快速健康检查（把 <BROKER_URL> 替换成你的地址）：

curl -sS -X POST "<BROKER_URL>/v1/github/device/start" \
  -H 'Content-Type: application/json' \
  -d '{}' | jq .

预期：返回类似 missing client_id 的 JSON 错误（说明 broker 端点可达）。

npm 使用

无需全局安装直接运行：

npm exec -y --package=omnimem --call "omnimem start"

或全局安装：

npm i -g omnimem
omnimem start

Agent 模式

omnimem codex
omnimem claude
omnimem codex --context-profile low_quota --quota-mode critical --show-context-plan
omnimem context-plan --prompt "summarize architecture and risks" --context-profile balanced --quota-mode auto

排障命令：

omnimem doctor
omnimem stop

常见问题

• 需要手动创建 SSH key 或 token 吗？
  • 常规流程不需要。可直接用 WebUI 的 GitHub OAuth 登录。
• 记忆同步是否经过服务器中转？
  • 不会。记忆同步仍是本机 Git 操作。
• OAuth broker 是做什么的？
  • 仅用于简化 GitHub OAuth 登录，不在记忆数据链路中。
• OAuth broker 一键部署按钮在哪？
  • 已在本 README 上方给出。完整说明见 docs/oauth-broker.zh-CN.md。

文档索引

• 中文文档入口：docs/README.zh-CN.md
• English docs entry: docs/README.md