CP Memory

Local-first, governable memory for AI coding agents.
Remember project rules across sessions, recall only what matters, and correct bad memory without hiding history.

简体中文 | English

Why CP Memory

• Local first: memory stays in ~/.cp-memory/memory.db by default.
• Governable: inspect, review, correct, scope, or retire memory instead of silently overwriting it.
• MCP-ready, Codex-enhanced: the stdio MCP server is the portable baseline; the Codex plugin adds Skills and lifecycle Hooks.

Quick Start — Codex Enhanced Integration

The currently verified one-command path is the Codex plugin:

codex plugin marketplace add CJhuochai/cp-memory
codex plugin add cp-memory@cp-memory

Restart Codex after installation and approve the lifecycle Hooks if prompted.

Portable MCP status: This repository now includes the cp-memory-mcp Python package and validates it in a clean environment. The public uvx cp-memory-mcp command will be documented only after the package is uploaded to PyPI and smoke-tested from the registry.

See The Result In 30 Seconds

1. Tell Codex a project rule, such as: “Releases must start on a branch, run tests, and merge through a PR.”
2. In a later session, CP Memory restores the relevant rule from the local primary store so Codex can continue following it.
3. If the rule is wrong, preserve correction history and mark the old record wrong, stale, or scoped instead of silently overwriting it.

CP Memory is a local-first memory plugin for Codex. It stores facts, preferences, ongoing work, episodes, decisions, and conversation checkpoints in a local SQLite database, then restores relevant context through MCP tools and lifecycle hooks.

The goal is not to remember as much as possible. The goal is memory that remains trustworthy after long-term use: explainable, reviewable, correctable, and governable.

Current Capabilities

• Context restore: restores relevant local-primary memory on startup and eligible prompts.
• Automatic extraction: conservatively creates long-term personal memory candidates from explicit statements.
• Project scope: prioritizes current-project memories with repo:, project:, and workspace: scopes.
• Reviewable governance: supports review inbox, review digests, conflict suggestions, correction states, and startup reminders.
• Safe maintenance: weekly maintenance runs health checks, governance preflight, and low-risk expiry cleanup only.

30-Second Example

You tell Codex:

Remember this: releases for this project must start on a branch, run tests, and merge through a PR.

In a later session, you ask:

What are the release rules for this plugin?

CP Memory restores the relevant memory from the local primary store first, and Codex follows that rule. If the memory is wrong, you can mark it wrong, mark it stale, or write a corrected version.

See more anonymized examples in docs/examples.md.

For a GIF, short video, or launch post, use the sanitized 30-second demo script.

Install

For Windows, the recommended path is GitHub Marketplace installation:

codex plugin marketplace add CJhuochai/cp-memory
codex plugin add cp-memory@cp-memory

Restart Codex after installation. If Codex asks you to trust hooks, approve the CP Memory lifecycle hooks in the hooks view.

For macOS/Linux, use the source installer. It creates a private Python runtime for the plugin and installs the MCP dependency:

git clone https://github.com/CJhuochai/cp-memory.git
cd cp-memory
sh ./install.sh

Restart Codex when it finishes. Do not treat GitHub Marketplace installation on macOS/Linux as an equivalently verified path: Marketplace does not run install.sh, so it does not create that private runtime.

Platform Support

Manual smoke testing of real Codex desktop Hook injection on macOS/Linux is still pending access to physical devices. This release is accepted through three-platform CI; the boundary does not affect the installer and MCP-startup checks already covered, but it is not a substitute for full desktop manual acceptance.

Safety

• Do not commit your real memory.db, logs, private summaries, or environment files.
• Automatic extraction is intentionally conservative. Generated memories can be reviewed, corrected, marked stale, or marked wrong.
• When memories need review, the current version injects a reminder into assistant context. It is not a user-facing popup or visible review panel, and it does not auto-delete memory or auto-resolve conflicts.
• Weekly maintenance runs health checks, governance preflight, and low-risk expiry cleanup only; long-term personal memories, tasks, and decisions are protected by default.
• Examples and screenshots use sanitized content, so you do not need to expose your real memory database.

Comparison

If you have seen other memory projects, start with docs/comparison.md. CP Memory's main difference is Codex lifecycle integration plus memory governance, not just storage and search.

Roadmap

See docs/roadmap.md for future directions. The roadmap prioritizes local-first behavior, explainability, correctability, and privacy safety.

See CHANGELOG.md for version history.

Local Development

Windows users normally do not need to run install.ps1. It is mainly for local development, refreshing the personal marketplace cache, and migrating old global hook wiring from earlier versions.

For local macOS/Linux development, run:

sh ./install.sh
sh ./scripts/test-install.sh

Python 3 with python3 on PATH is required. The installer creates a private virtual environment in the plugin directory and installs runtime dependencies; this is the currently verified installation path for macOS/Linux.

Run the test suite:

python -m unittest discover -s tests -p test_cp_memory.py

Validate the installer in an isolated temporary profile without touching your real Codex configuration:

powershell -ExecutionPolicy Bypass -File .\scripts\test-install.ps1

License

MIT