Back to home
Setup

Install mex

Install mex from the root of a Git repository with Node.js 22.5 or newer:

npx mex-agent@0.8.3 setup

That opens setup in a local browser Hub on your machine. There is no mex account. Canonical memory is written into the repo and shared later with git push.

Requirements

  • Node.js 22.5 or newer, with SQLite FTS5 in that Node build
  • An existing Git repository
  • macOS, Linux, Windows Command Prompt, PowerShell, or WSL

New repository

  1. cd to the repo root
  2. npx mex-agent@0.8.3 setup
  3. Choose your AI tools in the local Hub
  4. Let Claude Code or Codex populate project memory if available. If the agent is missing or fails, paste the population prompt into your agent and continue.
  5. Review the setup-file diff in Hub. Choose Commit setup for a local commit, or use the manual Git checkpoint. mex will not push or pull.
  6. Start a fresh agent session in the repo and confirm it reads project memory.
  7. Push the reviewed commit through the team’s normal Git workflow so teammates get the same memory files.

Do not add a broad .gitignore rule for .mex/. That hides the memory the team is supposed to share.

Optional

  • npx mex-agent@0.8.3 setup --cli (terminal / SSH)
  • npx mex-agent@0.8.3 setup --no-open
  • npx mex-agent@0.8.3 setup --port <n>
  • npm install -g mex-agent@0.8.3 then mex setup

Join a repo that already uses mex 0.8

Clone or pull, then in that checkout:

npx mex-agent@0.8.3 graph rebuild
npx mex-agent@0.8.3 wiki rebuild-index
npx mex-agent@0.8.3 hub

Reuse the committed memory. Do not regenerate it just to join.

After setup

npx mex-agent@0.8.3 hub

Hub listens on 127.0.0.1 and reads this checkout only. It is not a shared hosted dashboard.

Tools

ToolWhat 0.8 installsCommand
Claude Code.claude/skills//mex-inbox, /mex-relay
Codex.agents/skills/$mex-inbox, $mex-relay
Cursor, Windsurf, GitHub Copilot, OpenCodeinstruction anchor only in 0.8no official mex skill command

FAQ

Is this the hosted product on mexmemory.com?
No. This install is the open-source CLI. Memory stays in your repo. Early access on the homepage is a separate hosted product.
Do I need a mex account?
No.
Will setup push to GitHub?
No. It can make a local commit after you review. You push.
Where is the full reference?
https://github.com/mex-memory/mex
GitHub repo