Which agent do you use?

Pick yours. See just the steps you need.

Install your agent first. Choose Worker in the installer for memory on this computer. Choose your note-writing service and complete its account or key setup.

npx memindex install --ide claude-code
npx memindex doctor

In a terminal, the installer asks how MemIndex should write its notes. See Install for the shared setup steps.

The installer enables the MemIndex plugin in Claude Code. Start a new Claude Code session after setup.

Let an agent or script do it

If Claude Code, another agent or a script runs the install, use the command that never asks a question:

npx memindex install --ide claude-code --yes

It uses your Anthropic plan to write notes, keeps memory on this computer, starts the background service and waits until it answers. If the service cannot start, the command exits with an error and tells you which command to run.

What it changes

Copies the MemIndex plugin into ~/.claude/plugins and lists it in known_marketplaces.json and installed_plugins.json there.
Turns the plugin on in ~/.claude/settings.json, leaving your other settings alone. Native Claude Code memory stays on unless you pass --disable-auto-memory.
Creates ~/.memindex for your notes, settings and the viewer sign-in key.
Starts the background service.

Take it out

npx memindex uninstall

This stops the service and removes everything above except ~/.memindex, so your notes are kept.

Read the Claude Code guide

Install

Install MemIndex

Start with MemIndex on your own computer. Writing notes uses the model account or service you choose, which may have its own cost or usage limit. For hosting availability, see hosting and plans.

Before you start

You need Node.js 20.12 or newer and a supported agent. MemIndex checks for Bun and uv during installation and can install them if they are missing. On Windows, install Git for Windows with Git Bash.

Use a terminal you control. Have the model account or API key you plan to use ready. Keep keys out of shared logs and screenshots.

Install

npx memindex install

In the installer:

Select the agents you want to connect.
Choose Worker for memory on this computer.
Choose the service that will write your notes.
Complete the account or key setup it requests.

The interactive provider list offers your Anthropic plan, Gemini, and OpenRouter. The Anthropic choice can use your signed-in plan or configured API credentials. Using your plan shares its usage. Gemini and OpenRouter use your own API key. These services write the notes; they are separate from the agents MemIndex connects to. Check privacy for the default fallback when your chosen service cannot write notes.

Restart the selected agents when installation finishes. Open each agent's integration page for its setup checks and limits.

A global package install alone does not connect your agents. Use the install command above to set up the integrations and background service.

Install with no prompts

An agent or a script cannot answer questions, so give it this command instead:

npx memindex install --yes

It never waits for input. It connects Claude Code, writes notes with your Anthropic plan, keeps memory on this computer, and starts the background service. It prints the choices it made, then waits until the service answers. If the service does not start, the command exits with an error, says so in plain words, and names the command to run. To connect a different agent, add --ide with its name, for example --ide cursor. Add --no-auto-start to leave the service stopped.

The same thing happens whenever the command runs without a terminal, such as inside an agent's shell or a CI job.

What the installer changes

On your computer, the installer:

Copies the MemIndex plugin into ~/.claude/plugins and adds MemIndex to the plugin lists Claude Code reads there (known_marketplaces.json and installed_plugins.json).
Turns the plugin on in ~/.claude/settings.json. It leaves your other settings alone, and it changes Claude Code's native memory only if you pass --disable-auto-memory.
Creates ~/.memindex, which holds your notes, your settings, and a private key that signs you in to the viewer.
Installs Bun and uv if they are missing, and installs the plugin's own supporting packages.
Starts the background service.

Choosing another agent adds that agent's own hooks and settings; its integration page lists them. Telemetry stays off until you turn it on.

Check the installation

npx memindex doctor
npx memindex status

Doctor checks the installed files and supporting tools. Read the Worker daemon row too: the final “required checks passed” message can appear while the service is stopped.

If the service is stopped:

npx memindex start

Doctor reports the service address in its Worker daemon row. Open that address in your browser to view memory. Start a fresh agent session in a project. Do some work, then check the viewer for new notes. An empty history is normal before MemIndex has recorded work.

To change settings or delete memory, run:

npx memindex viewer

It opens the viewer in your browser, signed in for that tab. The installer prints only the plain address, because the signed-in link works like a password. To show the full link instead, run npx memindex viewer --print, and keep it out of shared logs and screenshots.

npx memindex start, stop, restart and status each print one plain sentence. Add --json when a script needs the machine-readable reply.

Use your Codex account to write notes

This choice is available through a command flag:

codex login
npx memindex install --provider codex --runtime worker

The agent you use and the service that writes notes are separate choices. Using Codex as your agent does not require using it to write notes.

Uninstall

npx memindex uninstall

This stops the background service and removes the plugin files, the plugin entries and the settings line described above. It keeps ~/.memindex, so your notes survive a reinstall. Delete that folder yourself if you want the notes gone too.

Update or repair

Get the latest package and update the installation:

npx memindex@latest update

If doctor reports missing dependencies or an incomplete installation:

npx memindex repair
npx memindex doctor

Repair can download supporting tools and install dependencies. For other failures, use troubleshooting.

For memory shared across machines, see hosting and plans. A server needs separate setup; choosing Server in the installer does not deploy one for you.