Skip to content

Installation

Jump to bottom
Jose Meira edited this page Sep 20, 2026 · 6 revisions

Installation

mnemo runs locally: one binary, one per-user event controller, and opt-in project integrations. Supported agents are Claude Code, Codex, Cursor, OpenCode and Pi.

Install

To install the current alpha:

curl -sSf https://raw.githubusercontent.com/jmeiracorbal/mnemo/main/install.sh | MNEMO_VERSION=v1.0.0-alpha.4 bash

Omit MNEMO_VERSION to install the latest stable release. mnemo update follows stable releases by default; use mnemo update --prerelease to opt into published alphas and betas. The --prerelease flag first ships in v1.0.0-alpha.2. Older binaries, including alpha.1, must use a pinned installer command to reach a newer version.

The installer detects agents (--agent=auto). To prepare one or all explicitly:

curl -sSf https://raw.githubusercontent.com/jmeiracorbal/mnemo/main/install.sh | bash -s -- --agent=codex
curl -sSf https://raw.githubusercontent.com/jmeiracorbal/mnemo/main/install.sh | bash -s -- --agent=all

Keep mnemo on the PATH visible to your agent application. The binary runs the MCP server, publisher commands, and the local controller. mnemo setup refresh --agent=all installs or refreshes the controller as a per-user service; macOS uses launchd, Linux uses systemd user services, and Windows uses Task Scheduler. No separate NATS installation is needed. Restart the agent after installation or updates.

Claude Code users can also install the plugin with claude plugin marketplace add jmeiracorbal/mnemo and claude plugin install mnemo@mnemo. The plugin does not replace the mnemo binary or its controller.

Activate a project

cd your-project
mnemo init --agent=all
mnemo doctor --agent=all --path=.
mnemo setup status --agent=all

Use --agent=claudecode, codex, cursor, opencode or pi to select one integration. mnemo init --no-project-rules creates only the project marker. The .mnemo file contains the canonical project ID; global integrations are inert without a valid marker. Do not derive the ID from the path or share a marker between unrelated clones.

Open an agent session in that project. Its integration publishes lifecycle events and exposes memory tools. Ask the agent to save a decision with mem_save and search with mem_search; do not create a manual CLI session. Agent Integrations explains each transport.

Update and remove

Released mnemo binaries check GitHub Releases during interactive CLI use. When a newer release exists, mnemo prints the installed and latest versions and asks before changing anything:

mnemo update
mnemo update --prerelease --check
mnemo update --prerelease
mnemo update --yes --agent=all
mnemo update --check --json
mnemo setup refresh --agent=all
mnemo setup uninstall --agent=codex

By default, mnemo update checks stable releases. --prerelease checks all published releases and selects the newest version, including alphas and betas. mnemo update downloads the official installer, pins it to the detected latest release, and refreshes mnemo's agent integration files after installing. It does not update Claude Code, Codex, Cursor, or other agent applications themselves.

Restart active agent sessions after updating so they reload the refreshed binary, hooks, and skills. Update checks are skipped in MCP, hook, and JSON-output paths so integrations remain machine-readable.

mnemo setup uninstall removes selected global integration files and the controller service according to the setup flow; check mnemo setup uninstall --help before removing a shared setup.

For a source build, run go build -o ~/.local/bin/mnemo ./cmd/mnemo/ and then mnemo setup refresh --agent=all. See Troubleshooting when the controller is unavailable.

Codex users must approve installed hooks through Codex's interactive trust review. See Agent Integrations.

Clone this wiki locally