Memorix

Memorix

面向 AI 编码 Agent 的本地优先共享记忆层。
一套项目记忆系统，适用于 Claude Code、Codex、CodeBuddy Code、Cursor、Windsurf、Copilot、Gemini CLI、OpenCode、Grok Build、OpenClaw、Hermes Agent、Oh-my-Pi、Pi、Kiro、Antigravity、Trae、DeepSeek Harness、WorkBuddy 以及任何支持 MCP 的 Agent。

已列入 MCP 官方注册表

共享项目记忆 | MCP | Git 记忆 | 推理记忆 | 插件 | 编排

网站 | 中文 | 安装 | 功能 | 支持的 Agent | 快速开始 | 记忆模型 | memcode | 当前工作 | 文档

---

维护者状态和当前公开的工作范围见 ACTIVE_WORK.md。这是仓库唯一持续更新的工作 跟踪文件。

Memorix 为你已经在使用的 AI 编码 Agent 提供共享、可搜索的项目记忆，并使其在开启新对话、切换 IDE、终端会话和交接任务后依然保留。记忆存放在 Git 项目中，而不是某个聊天窗口或工具里。

今天使用 Claude Code，明天使用 Codex，下午再用 Cursor。Agent 可以更换，项目记忆始终不变。

适合在以下情况下使用 Memorix： 你总要向新的 Agent 会话重复说明同一个项目：上次会话已经解决了某个问题，另一个 IDE 看不到相关内容，或某个设计决策埋在你再也找不到的聊天记录里。

问题	Memorix 带来的功能
下一次会话会忘记上一次会话学到的内容	项目范围的记忆、会话摘要、时间线和详情检索
不同 Agent 掌握的信息各不相同	通过 MCP、钩子、CLI、SDK 和内置终端 Agent 提供的统一本地记忆池
Git 记录了变更，但 Agent 无法很好地回忆这些变更	Git Memory 将提交转化为可搜索的工程事实
架构决策淹没在旧聊天记录中	Reasoning Memory 记录决策原因、备选方案和权衡
静态规则文件逐渐过时	注意事项、修复方案和项目技能会根据实际工作不断演进
并行 Agent 工作变得混乱	memorix orchestrate 协调任务上下文、交接、锁定、验证和审查循环

Memorix 以本地优先。SQLite 是规范存储。小型项目使用进程内 Orama 路径；较大型项目使用持久化的 SQLite FTS5 候选索引，并在可用时使用可选的本地 LanceDB 语义影子索引。 两个索引都可以重建，且不会限制可持久保存的记忆数量。基于 LLM 的记忆构建和嵌入仍为可选功能。

功能

Memorix 不只是一个记忆存储。它还会安装 Agent 集成、保留有用的工作事件、将提交转化为项目事实、提供本地控制平面，并可在任务需要时协调多 Agent 工作。

能力	功能	入口
Memory Autopilot	有边界的任务工作集，包含起始文件、当前记忆、有来源支持的知识、工作流起点、注意事项和验证。精简的 JSON 回执也能让 CLI 回退使用保持在限定范围内。	memorix context "..." --brief-json、memorix resume "..." --brief-json、memorix_project_context
Observation Memory	可搜索的事实、修复方案、易错点、会话摘要和实现说明，限定在当前 Git 项目范围内	memorix memory、MCP 记忆工具
Curated Long-term Memory	经过审慎审核的情景记忆、语义记忆和程序性记忆，并附有来源证据。只有明确标记为可移植的用户条目才能跨本地项目使用	memorix memory long-term
Code State and Code Memory	版本化的本地代码快照、有来源支持的 TypeScript/JavaScript 符号和关系、文件/符号链接以及新鲜度检查。其他语言会保留如实的 Lite 回退方案；已有索引的本地 CodeGraph 或 SCIP 结果可以提供有边界的外部概览，但不会取代本地索引。	memorix codegraph status|refresh|init|sync、自动上下文刷新
Git Memory	从提交中提取的工程事实，回答更改内容、所在位置及其重要性	memorix ingest commit、Git hook
Reasoning Memory	应在单次聊天结束后继续保留的设计依据、备选方案、权衡和风险	memorix reasoning、记忆形成
Knowledge Workspace	经过审核门控、具有来源支持的论断、Markdown 页面和规范项目工作流；提案不会悄然覆盖已审核的页面	memorix knowledge、memorix knowledge workflow
Agent setup	根据 Agent 选择一条设置路径，配置 MCP、规则、hook、技能、插件、套件或扩展	memorix setup --agent <agent>
Agent doctor	检查 Agent 的 MCP 配置和指导内容是否为最新，并在需要时修复由 Memorix 管理的条目	memorix doctor agents、memorix repair agents
Hooks and skills	支持的 Agent 可选择性地捕获内容，还可从持久知识中提炼可复用的项目技能	memorix hooks、memorix skills
Dashboard and HTTP	本地 Web UI 和共享 MCP 端点，可用于浏览记忆、项目状态、团队和诊断信息，以及预览优先的清理、整合、去重和保留操作	memorix dashboard、memorix background start
Orchestration and team work	任务规划、工作者交接、文件锁、消息、验证关卡和审核循环	memorix orchestrate、memorix team、memorix lock
memcode	内置的终端编码 Agent，可直接读取和写入同一项目记忆	memorix、memcode
CLI and SDK	可编写脚本的访问方式，用于自动化、导入/导出、诊断和自定义集成	memorix ...、createMemoryClient()
Optional multi-device sync	经过隐私筛选的观察事件，本地 SQLite 始终是规范数据源；默认限定在项目范围内，也可为每个本地项目选择 --scope user；支持 GitHub JSONL、文件系统、S3 或 Postgres 中继	memorix sync store status|push|pull

Memorix 通过各 Agent 已支持的接口进行连接：插件包、MCP、项目规则、hook、技能或内置终端 Agent。memorix setup 会为各 Agent 选择合适的设置方式，并将 stdio MCP 保持为默认传输方式。

Claude Code 官方插件 + MCP + 钩子 + 技能	Codex CLI 官方插件 + MCP + AGENTS.md	GitHub Copilot CLI 插件 + MCP + 钩子 + 技能	Cursor MCP + 规则 + 技能	Windsurf MCP + 规则 + 钩子	Gemini CLI 扩展 + MCP + 钩子 + 技能
OpenCode 本地插件 + MCP + 技能 + AGENTS.md	pi 编码 Agent 软件包 + 扩展 + 技能	Kiro MCP + 指导 + 钩子	Antigravity 插件 + MCP + 钩子 + 技能	Trae MCP + 项目规则	memcode 内置终端 Agent
OpenClaw 捆绑包 + MCP + 钩子 + 技能	Hermes Agent 插件 + MCP + 钩子 + 技能	Oh-my-Pi 软件包 + MCP + 钩子 + 技能	DeepSeek Harness MCP 补丁 + AGENTS.md + 技能	任意 MCP 客户端 stdio 或 HTTP MCP	Grok Build 原生钩子 + AGENTS.md

_{适用于支持 MCP、开放钩子/规则或支持插件/软件包条目的 Agent。所有这些 Agent 共享同一个本地优先记忆层。}

集成方式：

方式	功能	Memorix 入口
设置命令	安装推荐的一次性用户级 Memorix 集成	memorix setup --agent <agent> --global
MCP	为 Agent 提供精简的 Memorix 工具，用于项目上下文、搜索、详情检索、存储和解决问题	已打包在设置包中，或通过 memorix serve 提供
使用指南	教会 Agent 何时以及如何使用 Memorix，而不强制每次收到提示词都查找记忆	已打包，或由 memorix setup 生成
钩子	可选捕获提示词、工具事件、文件编辑、会话生命周期事件，以及 Agent 支持的原生压缩检查点	已打包，或由 memorix setup 生成
插件或捆绑包	在 Agent 支持的情况下安装插件、兼容的捆绑包或软件包文件	Claude Code、Codex、CodeBuddy Code、GitHub Copilot CLI、Antigravity、OpenClaw、Hermes Agent、Oh-my-Pi、Pi
扩展	在 Agent 支持的情况下安装扩展文件	Gemini CLI
本地插件	在 Agent 可直接加载的情况下安装本地插件文件	OpenCode
MCP/规则配置	为开放这些集成方式的 IDE 和 Agent 写入 MCP、规则、引导、使用指南或钩子配置	Cursor、Windsurf、Kiro、Trae、DeepSeek Harness、WorkBuddy
技能	将持久的项目知识转化为可复用的任务指南	memorix skills 和 memorix_promote
memcode	打开已使用 Memorix 记忆的捆绑终端 Agent	memorix 或 memcode

请参阅集成方式，了解当前支持情况以及各生成文件的用途。

只有当你有意在当前 Git 项目中使用仓库本地的使用指南、规则或钩子时，才使用不带 --global 的同一设置命令。

CLI、MCP 和 HTTP 是不同的入口：

• memorix CLI 是直接命令入口，可用于设置、记忆搜索/存储、Git Memory、导入/导出、仪表板、编排、诊断和自动化。
• memorix serve 是 IDE 和编码 Agent 使用的 stdio MCP 桥接服务。其默认工具配置文件为 micro，因此 Agent 只会看到精简的核心工具集。
• memorix background start / memorix serve-http 用于运行 HTTP 服务，以提供共享端点、仪表板、VPS Docker 部署或供多个客户端使用。

多设备存储同步为可选功能，且与 HTTP 共享分开。它绝不会上传实时 SQLite 数据库或 WAL 文件。默认情况下，它只会中继当前 Git 项目中符合条件且项目可见的观察记录；个人记录、面向特定 Agent 的记录、候选记录和临时记录都会保留在本地。传入 --scope user 可包含所有本地项目。首次推送前，请设置 MEMORIX_SYNC_PROVIDER，并检查 memorix sync store status --json。

要求：

• Node.js >=22.18.0
• Git，因为项目标识源自真实的 Git 根目录

安装并初始化：

npm install -g memorix
memorix init --global                   # optional defaults
memorix setup --agent claude --global   # or codex, copilot, cursor, pi, gemini-cli, opencode,
                                       # codebuddy, windsurf, kiro, antigravity, trae, openclaw, hermes, omp

memorix init 为可选命令。它会创建或更新 TOML 配置：

• ~/.memorix/config.toml 用于全局默认设置
• <git-root>/memorix.toml 用于可选的项目级覆盖设置

为保持兼容性，仍会读取旧版 memorix.yml、.env 和 ~/.memorix/config.json，但新的设置流程使用 TOML。

如果要为特定仓库配置仓库本地的使用指南或钩子，请在该仓库内运行同一设置命令，但不要加上 --global。Codex 是个例外：它支持的方式是用户级插件安装，因此 Memorix 不会改动项目的 .codex 配置。

连接现有 Agent

先使用 setup 命令。全局形式是通常的一次性安装方式：

memorix setup --agent claude --global
memorix setup --agent codex --global
memorix setup --agent copilot --global
memorix setup --agent cursor --global
memorix setup --agent pi --global
memorix setup --agent gemini-cli --global
memorix setup --agent opencode --global
memorix setup --agent windsurf --global
memorix setup --agent kiro --global
memorix setup --agent antigravity --global
memorix setup --agent trae --global
memorix setup --agent openclaw --global
memorix setup --agent hermes --global
memorix setup --agent codebuddy --global
memorix setup --agent omp --global
memorix setup --agent dsh --global
memorix setup --agent workbuddy --global
memorix setup --agent grok --global

具体安装内容取决于目标 Agent，但目标始终相同：让你在打开该 Agent 时都能使用 Memorix，无需手动配置每个代码仓库。

• Claude Code：安装 Memorix 插件包，添加 CLAUDE.md 指引，并在未传入 --noHooks 时启用钩子捕获。
• Codex：安装一个包含 stdio MCP、技能和生命周期钩子的用户级 Memorix 插件。它不会写入项目本地 .codex 配置，也不会更改你的模型、审批或沙箱设置。Codex 提示时，请使用 /hooks 审核一次插件钩子定义；--noHooks 会跳过自动捕获。
• GitHub Copilot CLI：安装 Copilot 插件包和官方 Memorix 技能。
• Pi：安装用户级 Pi 包和官方技能。
• Cursor：在所选范围内写入 Cursor MCP/规则/配置条目。
• Gemini CLI：安装扩展包、GEMINI.md 上下文、钩子和技能。Antigravity CLI 提供官方 Gemini CLI 迁移路径，但 Gemini CLI 仍是一个活跃的独立目标。
• OpenCode：安装本地插件文件、opencode.json、技能和 AGENTS.md 指引。
• Windsurf、Kiro、Trae：写入目标支持的 MCP/规则/钩子文件。
• Antigravity：在 ~/.gemini/config/plugins/memorix 或 .agents/plugins/memorix 下安装包含 plugin.json、mcp_config.json、hooks.json、规则和技能的官方插件包。
• OpenClaw：安装兼容 OpenClaw 的套件，其中包含 .mcp.json、官方技能和 OpenClaw HOOK.md/handler.ts 钩子包。
• Hermes Agent：安装到 Hermes 主目录（原生 Windows 上为 %LOCALAPPDATA%\hermes，其他系统上为 ~/.hermes，也可以是 HERMES_HOME），在 config.yaml 中启用插件，注册插件钩子、斜杠/CLI 命令和技能，并写入 MCP 配置。
• CodeBuddy Code：在 ~/.codebuddy/memorix-local 下安装用户范围的本地市场插件，其中包含 MCP、技能和钩子。它不会更改现有的 CodeBuddy 模型、权限或设置文件；CodeBuddy 仍通过其自身的 /hooks 流程审批第三方钩子。
• Oh-my-Pi：安装包含扩展钩子事件的 omp.extensions 包、memorix 命令和官方技能，并写入 MCP 配置。
• DeepSeek Harness：在 $DSH_HOME/cordis.patch.yml（默认为 ~/.dsh/cordis.patch.yml）中写入 Memorix @deepseek-ai/dsh-mcp-client 条目，向 harness 的 AGENTS.md 追加指引，并在 $DSH_HOME/skills 下安装官方技能。该条目遵循 DSH 自带的 Memorix 参考配置，因此工具会显示为 mcp__memorix__*。
• WorkBuddy：在 ~/.workbuddy/mcp.json（项目安装时为 <project>/.workbuddy/mcp.json）中写入 Memorix MCP 服务条目，并向 AGENTS.md 追加指引。工具会显示为 mcp__memorix__*；它没有钩子接口。
• Grok Build：在 ~/.grok/hooks/memorix.json 下安装原生生命周期钩子，并在 ~/.grok/AGENTS.md 中添加指引。默认情况下 MCP 由宿主管理；传入 --mcp http 可写入 [mcp_servers.memorix]，其中包含 url = "http://localhost:3211/mcp"。项目本地钩子需要 Grok /hooks-trust，而全局钩子默认受信任。设置 GROK_HOME 可使用自定义 Grok 主目录。

想要更精简的安装？对于可以将钩子捕获与宿主的官方包入口分开控制的目标，可添加 --noHooks。它会保留 MCP 和指引，但跳过 Memorix 钩子捕获。

如果你确实需要代码仓库本地的指引或钩子，请在该代码仓库内运行同一命令，但不要使用 --global。

如果你的 Agent 只需要手动配置 MCP 条目，请使用 stdio：

{
  "mcpServers": {
    "memorix": {
      "command": "memorix",
      "args": ["serve"]
    }
  }
}

对于基于 npm 的 MCP 客户端或注册表测试器，请使用完整命令 npx -y memorix serve。serve 参数很重要：由人工运行时，不带参数的 memorix 会打开捆绑的 memcode 终端 Agent，而 MCP 客户端应显式启动 stdio 服务。

对于手动管理的 Claude Code 配置项，请在 memorix 服务对象中添加 "alwaysLoad": true。这样，Claude Code 就能在打印模式启动期间提供 Memorix 工具；memorix doctor agents --agent claude 可以检测并修复缺失的设置。

常规设置不需要 HTTP。仅当你有意需要共享后台服务、仪表板、VPS Docker 部署，或多个客户端使用同一端点时才使用 HTTP。本地开发直接使用 Node 服务，无需 Docker：

memorix background start

然后将客户端指向：

http://localhost:3211/mcp

在 HTTP 模式下，如果客户端能提供工作区路径，Agent 应通过 memorix_session_start(projectRoot=...) 显式绑定当前仓库。Git 始终是项目身份的最终依据。

卸载

预览将要移除的内容：

memorix uninstall --dry-run

停止后台服务并移除钩子：

memorix uninstall --background --hooks

完全清理：

memorix uninstall --yes --background --hooks --purge-data
npm uninstall -g memorix

memorix uninstall 会报告需要手动清理的 MCP 配置项，而不会默默编辑它找到的所有 MCP 文件。

在命令行中工作

memorix --cwd /path/to/repo resume "continue release blocker"
memorix checkpoint list
memorix memory search --query "release blocker"
memorix memory --help

# Optional: activate one local agent identity for personal/team records and coordination.
memorix identity join --agent-type codex --name codex-main
memorix memory store --text "private investigation note" --visibility personal
memorix task create --description "verify the release package"

# Deliberate durable memory: create a candidate, then review it before it can enter a Workset.
memorix memory long-term add --kind procedural --scope user --portability portable --title "Release verification preference" --text "Run focused tests and a packed-package smoke before publishing." --applicability "When publishing an npm package."
memorix memory long-term qualify --id <id> --reason "The user explicitly confirmed this preference."
memorix memory long-term approve --id <id> --reason "Reviewed for future local projects."

memorix transfer export --format json --out ./.memorix-export.json
memorix transfer import --file ./.memorix-export.json
memorix reasoning search --query "why sqlite"
memorix git-hook --force
memorix ingest log --count 20
memorix workbench

CLI 操作直接执行，不依赖 MCP 会话。它会绑定到当前 Git 项目，或通过 --cwd 提供的项目。没有活动身份时，它只会读取、写入和导出项目可见的记忆。仅当你有意需要个人／团队记忆或协调任务操作时，才使用 memorix identity join 或 memorix identity use --agent-id <id>；memorix identity clear 会让终端返回项目范围。脚本可使用 --as <active-agent-id>，这是单命令替代方案。驼峰式和 kebab-case 标志均可使用。

管理受控媒体

媒体功能默认关闭。显式导入的本地文件会复制到 Memorix 的本地数据 目录、生成哈希，并保存在 Git 工作树之外。只有将其附加后，它才会成为普通记忆。 Memorix 不会捕获每一张屏幕截图或每一项工具输出。单个资源的大小最多可达配置的媒体上限（默认为 100 MiB）。自动视觉分析有意限制在 20 MiB 以内；更大的图像仍会保留并可附加，但 Memorix 会记录清晰的文本回退说明，而不会将超大载荷发送给模型提供商。

memorix media import --path ./architecture.png --json
memorix media attach --asset <asset-id> --title "Architecture diagram" --json
memorix media list --kind image --json
memorix media show --asset <asset-id> --json
memorix media remove --asset <asset-id> --force --json

# Controlled derivations: explicit, bounded, and attachable to memory.
memorix media derive-pdf --asset <asset-id> --attach --json
memorix media derive-audio --asset <asset-id> --attach --json

# Legacy image analysis now uses the same controlled asset lifecycle.
memorix ingest image --path ./architecture.png --json

MiniMax 图像生成是一项有意通过 CLI 执行的操作。视频生成会立即返回一个持久任务；请检查或取消该任务，而不要在 Agent 请求中等待。

# Configure MINIMAX_API_KEY in your user environment or .env, never in Git.
memorix media generate image --prompt "A clean system architecture diagram" --json
# Image-to-image with a reference image (MiniMax image-01 / image-01-live):
memorix media generate image --prompt "Keep the subject, change the background" --image ./reference.png --json
memorix media generate video --prompt "A short product walkthrough" --json
memorix media status --job <media-job-id> --json
memorix media cancel --job <media-job-id> --json

memorix_media 是所有配置档（包括 micro）中的精简 MCP 配套工具。它支持导入、附加、列表、查看、PDF／音频派生内容、 生成和任务状态。MCP 图像和视频生成默认禁用，因为它们可能产生提供商费用。 只有在你明确希望 Agent 请求需要付费的 MiniMax 输出时，才设置 MEMORIX_MCP_MEDIA_GENERATION=1。常规 OpenRouter 文本嵌入通道仍然仅支持文本；只有明确声明支持相应模态的提供商才会创建媒体向量。文本描述和附件仍然是实用的常规检索回退方式。

使用捆绑的终端 Agent

memorix
# or
memcode

这会打开 memcode，这是一个终端编码 Agent，它使用与 MCP 连接的 Agent 相同的 Memorix 项目记忆。

| 层级 | 存储内容 | 最适用场景 | | --- | --- | --- | | 观察记忆 | 事实、注意事项、修复方案、实现说明 | “这是如何运作的？” | | 推理记忆 | 理由、替代方案、约束、风险 | “我们为什么这样选择？” | | Git 记忆 | 从提交中提取的工程事实 | “发生了哪些更改，位于何处？” | | 代码记忆 | 文件、符号、导入关系，以及记忆与代码的新鲜度 | “我应该先检查哪些当前代码？” | | 精选长期记忆 | 经审核、有证据支持的情景事件、稳定事实或可复用流程 | “这个 Agent 以后还应该记住或执行什么？” | | 精简连续性 | 最近由宿主原生生成的精简摘要或生命周期标记 | “上次上下文压缩后保留了什么？” |

默认情况下，搜索限定在项目范围内。scope="global" 会跨项目搜索。对于“发生了哪些更改”类问题，搜索会提高 Git 记忆的权重；对于“为什么”类问题，则会提高推理记录的权重。

长期记忆并非自动汇集所有笔记。源观察、Claim、工作流、会话和代码快照均保留各自原有的用途。Agent 可以要求 memorix_store 创建一条额外的长期记录；明确提出的请求会自动获得资格，并作为持久锚点加入任务简报，而由钩子捕获或从 Git 派生的候选项则会保持待定，直到获得资格。是否批准仍需由操作员明确审核。使用 memorix memory long-term approve|archive|supersede 记录有证据支持的生命周期状态。只有手动创建或经用户确认的 user + portable 条目，才可考虑用于其他本地项目；项目代码、Git 事实、测试、工作流、会话和观察均不能提升为可移植的用户记忆。

memorix context "..." 是默认的 Memory Autopilot 入口。它会为 Agent 生成一份精简且聚焦任务的简报：修复错误的任务侧重测试和复现步骤，发布任务侧重软件包／变更日志／构建检查，新手引导任务侧重文档和入口点；过时或无关的记忆则会放在警告区域，而不会淹没提示词。MCP 不可用且命令行回退需要生成同样有界的简报，并附上所选或省略内容的记录时，请使用 --fallback --brief-json；--json 仍会输出详细诊断信息。普通新任务不会收到旧会话的完整内容。对于明确的续接任务，memorix resume "..." 只会加入最新的实用会话摘要、最多三个可读的持久锚点，以及至多一个近期的、带来源标签的宿主精简检查点。持久锚点包含 durable:<id> 引用，因此 Agent 只需在必要时通过 memorix_detail 展开完整的已审核记录。关键词匹配仍是首选；如果没有匹配的已审核持久条目，且已配置嵌入提供方，Memorix 会针对改述或跨语言任务执行一次 1.8 秒、无重试的语义回退。提供方响应缓慢或不可用时，正常的纯关键词工作集不受影响。检查点是生命周期证据，不是持久记忆或对话记录备份。Agent 应先阅读建议的文件，再决定是否信任存储的记忆。

| 你想要 | 运行 | | --- | --- | | 安装 Agent 集成包 | `memorix setup --agent --global` | | 检查或修复 Agent 集成 | `memorix doctor agents --agent `, `memorix repair agents --agent ` | | 手动公开 stdio MCP | `memorix serve` | | 运行共享 HTTP MCP 和仪表板 | `memorix background start` | | 在前台调试 HTTP MCP | `memorix serve-http --port 3211` | | 直接检查或管理记忆 | `memorix memory`, `memorix reasoning`, `memorix session`, `memorix ingest`, `memorix media` | | 管理经审核的长期记忆 | `memorix memory long-term list|show|add|promote|qualify|approve|archive|supersede` | | 从检索中移除记忆 | `memorix purge`（当前项目），`memorix purge --all --yes`（所有内容） | | 检查原生压缩连续性 | `memorix checkpoint list|show|context|archive` | | 使用交互式终端记忆控制平面 | `memorix workbench` | | 使用捆绑的终端 Agent | `memorix` 或 `memcode` | | 运行编排的子 Agent 工作 | `memorix orchestrate --goal "..."` |

memorix serve 默认使用 --mode micro（9 个工具），以保持面向 Agent 的 MCP 工具架构较小。memorix setup 会在已安装的 MCP 配置中写入 --mode lite（21 个工具），以便访问常用记忆、连续性和会话功能。使用 --mode team（29 个工具）可启用协调工具，使用 --mode full（48 个工具）可启用高级工具和兼容性工具，例如检查点检查功能。

快捷方式和别名：memorix search / remember / recent 是直接查询快捷方式，bg/bs 用于启动后台服务，hook 用于运行钩子启动器，memorix config get|path|migrate 用于检查或迁移配置文件。

memorix orchestrate 在单个工作者运行时使用当前检出目录。运行多个工作者时，它会在 .worktrees/ 下创建任务工作树，并将成功的任务分支合并回来。使用 --isolated 可强制单个工作者使用工作树隔离，使用 --no-worktree 可禁用此功能，使用 --allow-dirty 可在存在未提交更改时运行，使用 --no-auto-merge 可保留任务工作树以供手动审核。

memcode 是 Memorix 捆绑的终端编码 Agent。它可以读取和编辑文件、运行命令、恢复会话、切换模型并使用 /memory 命令——所有操作都由与你通过 MCP 连接的 Agent 共用的项目记忆提供支持。

如果你想要一个已接入记忆功能的终端 Agent，可以使用它。

one Git project -> one shared Memorix memory pool

请参阅 docs/MEMCODE.md，了解 memcode 专属指南。

最精简的 ~/.memorix/config.toml：

[agent]
provider = "openai"
model = "gpt-4o"
api_key = "..."

[memory.llm]
provider = "openai"
model = "gpt-4o-mini"
api_key = "..."

[embedding]
provider = "auto"

[memory]
inject = "minimal"
formation = "active"

使用 [memory.llm] 和 [embedding] 配置 Memorix 的记忆质量和检索。使用 [agent] 配置 memcode 编码时使用的模型。将凭据保存在全局配置或环境变量中，不要提交机密信息。

要使用可选的 Atlas Cloud 记忆预设，请运行 memorix init 并选择 Atlas Cloud，或在 [memory.llm] 中设置 provider = "atlascloud"。它使用 兼容 OpenAI 的 https://api.atlascloud.ai/v1 端点，并读取 ATLASCLOUD_API_KEY 或显式设置的 MEMORIX_LLM_API_KEY。

要使用 OpenRouter 嵌入，请设置 provider = "api"、base_url = "https://openrouter.ai/api/v1" 和 model = "qwen/qwen3-embedding-8b"。对于该嵌入端点，Memorix 接受 OPENROUTER_API_KEY；MEMORIX_EMBEDDING_API_KEY 仍可作为显式覆盖项。 对于 Requesty，请在 memorix init 中选择 Requesty，或在 [memory.llm] 中设置 provider = "requesty"（端点为 https://router.requesty.ai/v1，密钥来自 REQUESTY_API_KEY 或 MEMORIX_LLM_API_KEY）。Requesty 嵌入使用 provider = "api"、base_url = "https://router.requesty.ai/v1" 和 model = "openai/text-embedding-3-small"，并使用 REQUESTY_API_KEY。

对于 API Route，请在 memorix init 中选择 API Route，或在 [memory.llm] 中设置 provider = "apiroute"。该预设使用 https://global.api-route.com/v1 和 deepseek-v4.1-flash，并使用您自己的 API_ROUTE_API_KEY 或 MEMORIX_LLM_API_KEY。这是选择启用的记忆大模型处理；嵌入和 memcode 的模型注册表需单独配置。请参阅配置。

对于 Cheaper Inference，请在 memorix init 中选择 Cheaper Inference，或在 [memory.llm] 中设置 provider = "cheaperinference"。该预设使用 https://api.cheaperinference.com/v1 和 gpt-5.4-mini，并使用您自己的 CHEAPER_INFERENCE_API_KEY 或 MEMORIX_LLM_API_KEY。这是选择启用的记忆大模型处理；嵌入和 memcode 的模型注册表需单独配置。请参阅配置。

如需可控的 MiniMax 媒体生成，请在环境或 .env 中设置 MINIMAX_API_KEY（全局）或 MINIMAX_CN_API_KEY（中国区）。媒体库绝不会存储该密钥、签名输出 URL 或 Base64 负载。CLI 生成需要显式调用；MCP 生成还需要 MEMORIX_MCP_MEDIA_GENERATION=1。

Docker 是用于 VPS／托管 HTTP 部署的选项，并非本地开发或 stdio MCP 的必需项：

docker compose up --build -d

然后打开：

• 仪表板：http://localhost:3211
• MCP：http://localhost:3211/mcp
• 健康状态：http://localhost:3211/health

容器必须能够访问通过 projectRoot 传入的仓库路径，才能实现项目范围的 Git 和配置行为。

在 TypeScript 中直接使用 Memorix：

import { createMemoryClient } from 'memorix/sdk';

const client = await createMemoryClient({ projectRoot: '/path/to/repo' });

await client.store({
  entityName: 'auth-module',
  type: 'decision',
  title: 'Use JWT for API auth',
  narrative: 'Chose JWT because the API is stateless and used by multiple clients.',
});

const results = await client.search({ query: 'auth decision' });
await client.close();

从这里开始	适用场景
文档索引	您想以最短路径找到合适的指南
设置指南	安装、使用 memorix setup、选择 stdio 还是 HTTP
集成方式	插件包、MCP、项目规则、钩子和技能支持
配置	TOML 配置、模型通道、兼容文件
API 参考	MCP 工具和 CLI 命令
Git 记忆	提交内容摄取和可搜索的工程事实
Docker	容器化 HTTP 服务
memcode	使用内置终端 Agent
Agent 操作手册	面向 AI 的安装、绑定、钩子和故障排除执行指南
开发	贡献、测试、发布检查
变更日志	各版本的变更内容

面向大模型的摘要：llms.txt 和 llms-full.txt。

git clone https://github.com/AVIDS2/memorix.git
cd memorix
npm install
npm run lint
npm test
npm run build

社区

基于 Memorix 构建的桌面和 Shell 集成：

• omarchy-memorix — 原生 Omarchy Shell 栏小组件：池统计信息、实时全局搜索、按项目分类的概览、近期记忆和工作台启动器。以只读方式访问 ~/.memorix/data；无需守护进程，也不收集遥测数据。

基于 Memorix 构建了什么？欢迎提交 PR，将其列在这里。

Memorix 借鉴了 MCP 生态系统以及 mcp-memory-service、MemCP、claude-mem 和 Mem0 等以往的记忆项目。memcode 基于 Pi 编码 Agent 代码库，并将其终端 Agent 模型适配到 Memorix 生态系统。

Apache 2.0

Star 历史

_{从 GitHub 注重隐私的 Star 历史 API 自动更新。不生成 PR。}