by AVIDS2
Open-source cross-agent memory layer for coding agents via MCP. Compatible with Cursor, Claude Code, Codex, Windsurf, Gemini CLI, GitHub Copilot, Kiro, OpenCode, Antigravity, and Trae.
# Add to your Claude Code skills
git clone https://github.com/AVIDS2/memorixIf you are using an AI coding agent to install or operate Memorix, have it read the Agent Operator Playbook first.
That playbook is the canonical AI-facing guide for:
Most coding agents remember only the current thread. Memorix gives them a shared, persistent memory layer across IDEs, sessions, and projects.
What makes Memorix different:
git commit into searchable engineering memory with noise filtering and commit provenance.Memorix is built for one job: let multiple coding agents share the same durable project memory through MCP without giving up Git truth, reasoning history, or local control.
Version 1.0.6 is the release where Memorix's memory model became much more explicit, safer, and easier to operate.
explicit, , ) and value categories (, , ).No comments yet. Be the first to share your thoughts!
hookgit-ingestcorecontextualephemeralpost_compact event instead of implying automatic MCP tool calls during compaction.Memorix currently ships first-class integrations for:
If a client can speak MCP and launch a local command or HTTP endpoint, it can usually connect to Memorix even if it is not in the list above yet.
Install globally:
npm install -g memorix
Initialize Memorix config:
memorix init
memorix init lets you choose between Global defaults and Project config.
Memorix uses two files with two roles:
memorix.yml for behavior and project settings.env for secrets such as API keysThen pick the path that matches what you want to do:
| You want | Run | Best for |
| --- | --- | --- |
| Quick MCP setup inside one IDE | memorix serve | Cursor, Claude Code, Codex, Windsurf, Gemini CLI, and other stdio MCP clients |
| Dashboard + long-lived HTTP MCP in the background | memorix background start | Daily use, multiple agents, collaboration, dashboard |
| Foreground HTTP mode for debugging or a custom port | memorix serve-http --port 3211 | Manual supervision, debugging, custom launch control |
Most users should choose one of the first two options:
memorix serve if you just want Memorix available inside your IDE as fast as possiblememorix background start if you want the dashboard and a shared HTTP control plane running in the backgroundOptional local UI:
memorix
Use bare memorix only when you want the interactive local workbench in a TTY. It is not the main setup path for most users.
Companion commands:
memorix background status
memorix background logs
memorix background stop
If you need the HTTP control plane in the foreground for debugging, manual supervision, or a custom port, use:
memorix serve-http --port 3211
If you are using the HTTP control plane across multiple workspaces or agents, make sure each session binds with memorix_session_start(projectRoot=...).
The deeper details around startup root selection, project binding, config precedence, and agent/operator workflows live in docs/SETUP.md and the Agent Operator Playbook.
Add Memorix to your MCP client:
{
"mcpServers": {
"memorix": {
"command": "memorix",
"args": ["serve"]
}
}
}
{
"mcpServers": {
"memorix": {
"transport": "http",
"url": "http://localhost:3211/mcp"
}
}
}
If you use the HTTP control plane across multiple workspaces or agents, the client or agent should also call memorix_session_start(projectRoot=ABSOLUTE_WORKSPACE_PATH) at the beginning of each project session.
The per-client examples below show the simplest stdio shape. If you prefer the shared HTTP control plane, keep the generic HTTP block above and use the client-specific variants in docs/SETUP.md.
{
"mcpServers": {
"memorix": {
"command": "memorix",
"args": ["serve"]
}
}
}
claude mcp add memorix -- memorix serve
[mcp_servers.memorix]
command = "memorix"
args = ["serve"]
For the full IDE matrix, Windows notes, and troubleshooting, see docs/SETUP.md.
Use MCP tools such as:
memorix_storememorix_searchmemorix_detailmemorix_timelinememorix_resolveThis covers decisions, gotchas, problem-solution notes, and session handoff context.
Install the post-commit hook:
memorix git-hook --force
Or ingest manually:
memorix ingest commit
memorix ingest log --count 20
Git memories are stored with source='git', commit hashes, changed files, and noise filtering.
memorix background start
Then open:
http://localhost:3211/mcphttp://localhost:3211Companion commands:
memorix background status
memorix background logs
memorix background stop
Use background start as the default long-lived HTTP mode. If you need to keep the control plane in the foreground for debugging or manual supervision, use:
memorix serve-http --port 3211
This HTTP mode gives you collaboration tools, project identity diagnostics, config provenance, Git Memory views, and the dashboard in one place.
When multiple HTTP sessions are open at once, each session should bind itself with memorix_session_start(projectRoot=...) before using project-scoped memory tools.
flowchart LR
subgraph Ingress["Ingress Surfaces"]
A1["Git hooks / ingest"]
A2["MCP tools"]
A3["CLI / TUI"]
A4["HTTP dashboard"]
end
subgraph Runtime["Memorix Runtime"]
B1["stdio MCP server"]
B2["HTTP control plane"]
B3["project binding + config"]
end
subgraph Memory["Memory Substrates"]
C1["Observation memory"]
C2["Reasoning memory"]
C3["Git memory"]
C4["Session + team state"]
end
subgraph Processing["Async Processing"]
D1["Formation pipeline"]
D2["Embedding + indexing"]
D3["Graph linking"]
D4["Dedup + retention"]
end
subgraph Consumption["Consumption Surfaces"]
E1["Search / detail / timeline"]
E2["Dashboard / team views"]
E3["Agent recall / handoff"]