Skip to content

README.md

Latest commit

 

History

History
106 lines (71 loc) · 3.07 KB

README.md

File metadata and controls

106 lines (71 loc) · 3.07 KB

Codex Auto Memory

让 Codex 在后续会话里延续项目上下文，同时把记忆保留在你能直接查看和编辑的 Markdown 里。

简体中文 | 繁體中文 | English | 日本語

codex-auto-memory 让 Codex 在跨会话协作里继续带着项目上下文、偏好和关键决策工作，同时保持 MEMORY.md、topic files 和相关检查入口都在本地。你不需要额外的数据库，也不用把“记忆”交给一个看不见的黑盒。

为什么用它

  • 把未来仍然有用的信息从 Codex 会话里提取出来，并在后续会话里带回来。
  • 保持 MEMORY.md 与 topic files 作为可读、可改、可审计的主表面。
  • 通过 cam memory、cam recall、cam session 这组命令，在把记忆带回工作流之前先检查它。

安装前提

  • Node 20+
  • 源码安装路径需要 pnpm

安装

用 Claude Code / OpenCode / Codex 让 agent 帮你装

如果你更习惯让 coding agent 直接完成安装，可以把下面这段提示词原样复制给 Claude Code、OpenCode 或 Codex：

Install codex-auto-memory on this machine for me.

Use the npm install path from this README first:
npm install --global codex-auto-memory

After that:
1. Verify the install with `cam --version`
2. In the current repository, check whether codex-auto-memory is already initialized
3. If it is not initialized, run `cam init`
4. Show me the exact commands you ran and the results

If the npm package is unavailable, fall back to the GitHub Release tarball install path from this README instead of inventing another route.
Do not modify unrelated files.

npm

这是最省事的安装路径：

npm install --global codex-auto-memory

GitHub Release tarball

如果你想安装指定版本的打包产物，使用 GitHub Release tarball：

curl -LO https://github.com/Boulea7/Codex-Auto-Memory/releases/download/v<version>/codex-auto-memory-<version>.tgz
npm install --global ./codex-auto-memory-<version>.tgz

源码安装并构建

如果你要改源码，或者想直接从仓库本地运行：

pnpm install
pnpm build
pnpm link --global

第一个命令

cam init
cam run

安装完成后，最常用的检查命令是：

cam memory
cam recall search "<query>"
cam session status
cam remember "<memory>"
cam forget "<memory>" --archive

文档

社区与仓库健康

当前状态

项目目前仍然是 Codex-first、Markdown-first 的本地记忆工具。更细的集成边界、宿主差异和迁移说明都放在文档中心。

许可

Apache-2.0