SoDam_O-Brain

<!-- 한국어: 이 파일 · English: README.en.md · 상세 가이드: GUIDE.md · (이 문서와 README.pdf 내용 동일) --> # 小谈大脑 — AI 记忆系统 > **与 AI 对话中自动保存重要决策和承诺，并以知识图谱可视化。** **比喻一句话：** AI 是天才，但对话结束后它会忘记一切。 O-Brain 是放在 AI 旁边的 **自动记忆笔记本**。它会自动记录重要信息，并随时为您呈现。 --- ## 核心功能 | 功能 | 说明 | |------|------| | **100% 本地** | 所有记忆都存储在您的电脑上，不传输到外部服务器或云端 | | **混合搜索** | 同时使用关键词（全文搜索）和语义相似度（向量搜索） | | **知识图谱** | 将记忆以 2D/3D 点和线条可视化 | | **时间旅行** | 按日期查询在该日期有效的记忆 | | **信任度衰减** | AI 提取的记忆信任度每 30 天自动减少一半 | | **安全过滤** | 自动删除 API 密钥和密码，并替换为 `[REDACTED]` | | **自动备份** | 服务器启动和批量删除前自动创建快照 | | **MCP 联动** | 与 Claude Code 連携，实现 7 种工具的记忆存储、搜索和管理 | | **孤立节点可视化** | 对无关记忆节点显示虚线边框 | --- ## 使用前准备 | 项目 | 要求 | |------|-----------| | 操作系统 | Windows 10 / 11 (64-bit) | | Node.js | 20.x LTS 或以上（从 [nodejs.org](https://nodejs.org) 免费安装） | | 存储空间 | 500 MB 以上（含约 90 MB 的嵌入模型） | | RAM | 4 GB 以上（推荐 8 GB 以上） | | 浏览器 | Chrome, Edge, Firefox 等 | > Claude Code 仅在与 MCP 工具联动时需要。网页仪表盘无需 Claude Code 即可使用。 --- ## 安装（2 步） **步骤 1：安装依赖（在终端中）** ```bash cd D:\AI_Dev_Work\2026y\26y_06m_21d_SoDam_O-Brain\app npm install ``` **步骤 2：启动服务器** ```bash npm start ``` 出现 `O-Brain 本地服务器 ▶ http://127.0.0.1:7740` 消息即表示成功。 **在浏览器中打开：** ``` http://127.0.0.1:7740 ``` > **首次运行**：会自动下载 AI 嵌入模型（约 90 MB）。需时 1-3 分钟。后续运行即可立即启动。 --- ## Claude Code 插件方式（可选） 如果您正在使用 Claude Code，可以通过插件安装： ``` /plugin marketplace add D:\AI_Dev_Work\2026y\26y_06m_21d_SoDam_O-Brain\plugin /plugin install o-brain@o-brain-local ``` 重启 Claude Code 后，可使用斜杠命令： | 命令 | 功能 | |------|---------| | `/o-brain:status` | 查询当前记忆数和状态 | | `/o-brain:selftest` | 存储、搜索、安全一体化检查（✅✅✅ 则正常） | | `/o-brain:remember` | 从当前对话中提取并存储决策 | | `/o-brain:link` | 连接记忆节点 | | `/o-brain:backup` | 手动创建备份 | | `/o-brain:open` | 在浏览器中打开仪表盘 | --- ## MCP 工具联动（Claude Code） 在 Claude Code 的 `settings.json` 中注册，即可在对话中直接存储和搜索记忆： ```json { "mcpServers": { "o-brain": { "command": "node", "args": ["C:/绝对路径/app/src/mcp-server.mjs"] } } } ``` 可用 MCP 工具：`save_memory`, `search_memory`, `get_memory`, `get_related`, `get_timeline`, `add_relation`, `list_categories` --- ## 主要命令 ```bash # 在 app/ 目录下运行 npm start # 启动服务器（端口 7740） npm run selftest # 自我诊断 npm run backup # 手动备份 npm run status # 数据库状态查询 npm run seed # 输入示例数据（用于测试） ``` --- ## 文件和数据位置 | 项目 | 位置 | |------|------| | 记忆数据库 | `app/data/obrain.db` | | 自动备份 | `app/data/backups/` （保留最新 10 个） | | API 令牌文件 | `app/data/.api-token` （每次运行更新） | | 个人设置 | `app/.env.local` （若不存在，则使用默认值） | ### 环境变量 (`app/.env.local`) | 变量 | 默认值 | 说明 | |------|--------|------| | `OBRAIN_PORT` | `7740` | 服务器端口号 | | `OBRAIN_DATA_DIR` | `./data` | 数据存储文件夹 | --- ## 安全概述 - 服务器仅绑定到 **127.0.0.1（本机）** — 外部设备无法访问 - 记忆存储前 **自动删除 API 密钥和密码** （redact.mjs 处理） - 每次服务器启动都会生成新的 **本地 API 令牌** （crypto.randomBytes） - `data/`、`.env.local` 和 `*.sqlite` 被包含在 `.gitignore` 中 — 绝不会上传到 Git - 无外部云通信。嵌入模型完全在本地运行 --- ## 架构总结 ``` [Claude Code / 浏览器] ↓ [Express 服务器 127.0.0.1:7740] ↓ [安全过滤器] → [嵌入（本地 AI）] → [SQLite 数据库] ├── FTS5 （关键词搜索） └── sqlite-vec （向量搜索） ``` 技术栈：Node.js ES 模块 · Express.js v5 · SQLite (better-sqlite3) · sqlite-vec · @huggingface/transformers (all-MiniLM-L6-v2) · force-graph / 3d-force-graph · @modelcontextprotocol/sdk --- ## 问题解决快速参考 | 症状 | 解决方法 | |------|------| | `'node' 不是命令` | 从 [nodejs.org](https://nodejs.org) 安装 LTS → **重新打开终端** | | `EADDRINUSE :::7740` | 在 `.env.local` 中添加 `OBRAIN_PORT=7741` 后重启 | | 图谱为空 | 运行 `npm run seed` 添加示例数据 | | 浏览器无法访问 | 确认 `npm start` 已运行 → 地址是否为 `http://127.0.0.1:7740` | | 嵌入模型下载失败 | 检查网络连接 → 允许 Node.js 通过防火墙 | | 错误记忆删除 | 从 `app/data/backups/` 恢复最新的 `.db` 文件 | 详细指南： **[GUIDE.md](./GUIDE.md)** （中文） · **[GUIDE.en.md](./GUIDE.en.md)** （英文） --- ## 许可证 · 著作权 · 商业用途 **Apache License 2.0 © SoDam AI Studio, 2026** | 项目 | 内容 | |------|------| | 个人使用 | 免费使用 | | 修改 · 复制 | 允许（必须保留版权信息） | | 商业使用 | 在 Apache-2.0 条件允许下 | | 保修 | **无** （AS-IS）— 使用结果责任归用户 | | 外部服务 | Claude / Anthropic 等外部服务条款单独适用 | - 内置开源库（better-sqlite3, sqlite-vec, @huggingface/transformers, force-graph 等）遵循 **各自的许可证**（MIT/Apache-2.0） - "Claude", "Anthropic" 是其公司的商标。O-Brain 与它们 **无官方合作**。 - 许可证全文：`LICENSE` 文件 --- *本文与 README.pdf 内容相同。* *详细指南： [GUIDE.md](./GUIDE.md) （中文） · [GUIDE.en.md](./GUIDE.en.md)** （英文）