How to Install DeusData codebase-memory-mcp Locally

Run the official install.sh (macOS/Linux) or install.ps1 (Windows) script to download the pre-built binary, verify its checksum, add it to your PATH, and auto-configure supported coding agents such as Claude Code and Codex CLI.

The DeusData codebase-memory-mcp project ships as a single static binary that works across macOS, Linux, and Windows. Whether you need persistent codebase memory for your AI agent or the optional 3-D graph visualization, local installation takes minutes and requires no manual compilation.

One-Line Local Installation on macOS and Linux

The quickest way to install DeusData codebase-memory-mcp locally is through the remote installer script. This script is fully self-contained and handles architecture detection, checksum verification, PATH updates, and macOS quarantine cleanup automatically.

curl -fsSL https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.sh | bash

For the UI-enabled build that starts the visualization server, append the --ui flag:

curl -fsSL https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.sh \
  | bash -s -- --ui

After installation, restart your coding agent. The installer detects Claude Code, Codex CLI, VS Code, and other supported agents, then writes the required MCP configuration entries automatically.

Local Installation on Windows with PowerShell

Windows users can run the equivalent PowerShell installer from the repository. The process downloads the pre-built binary, verifies its checksum, and configures agent settings just like the macOS/Linux version.

Invoke-WebRequest -Uri https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.ps1 `
  -OutFile install.ps1

Inspect the script before execution:

notepad install.ps1

If Windows blocks the script, unblock it and run:

Unblock-File .\install.ps1
.\install.ps1

Optional Flags for a Custom Local Install

Both install.sh and install.ps1 support optional flags that change the installation behavior without manual file editing.

Install the UI-Enabled Binary

Add --ui to fetch the build that includes the 3-D graph visualization at http://localhost:9749. According to the installer logic, this variant is published as a separate archive with the -ui suffix.

# macOS / Linux

curl -fsSL https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.sh \
  | bash -s -- --ui

Skip Agent Configuration

Add --skip-config if you only want the binary and do not want the installer to touch any agent configuration files. This is useful for CI containers or secondary workstations.

curl -fsSL https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.sh \
  | bash -s -- --skip-config

Set a Custom Installation Directory

Use --dir=<path> to override the default ~/.local/bin (or Windows equivalent). The installer copies the binary to the specified folder and ensures it is reachable from your shell.

curl -fsSL https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.sh \
  | bash -s -- --dir=/opt/tools

Manual Offline Installation from Release Archives

If you prefer an offline install or cannot run remote scripts, download the pre-built archives from the releases page and extract them manually.

macOS / Linux – standard binary:

tar xzf codebase-memory-mcp-linux-amd64.tar.gz
./install.sh

macOS / Linux – UI-enabled binary:

tar xzf codebase-memory-mcp-ui-linux-amd64.tar.gz
./install.sh --ui

Windows – standard binary:

Expand-Archive codebase-memory-mcp-windows-amd64.zip -DestinationPath .
.\install.ps1

Even in manual mode, the local install.sh or install.ps1 handles the final placement and agent configuration.

Verify the Installation and Launch the UI

Confirm the binary is on your PATH by checking its version or help output. To start the optional visualization dashboard, pass the --ui=true flag and open your browser.

codebase-memory-mcp --ui=true --port=9749

Navigate to http://localhost:9749 to view the interactive 3-D graph of your codebase memory.

You can also enable automatic indexing for every new project by running:

codebase-memory-mcp config set auto_index true

Full runtime options are documented in docs/CONFIGURATION.md inside the repository.

Key Installer Files in the Source Repository

Understanding the repository layout helps if you need to audit the installer or build from source later.

• install.sh — The macOS/Linux shell installer. It fetches the correct pre-built binary, verifies checksums, strips macOS quarantine attributes when needed, and updates supported agent configs.
• install.ps1 — The Windows PowerShell installer that mirrors install.sh, including binary selection and agent configuration.
• scripts/build.sh — The build pipeline used to compile the binary from C source and tree-sitter grammars.
• docs/CONFIGURATION.md — Reference for environment variables and runtime flags.
• README.md — High-level overview, quick-start snippets, and platform-specific notes.
• LICENSE — MIT license governing the source code.

Summary

• DeusData codebase-memory-mcp installs locally via a single script: install.sh for macOS/Linux or install.ps1 for Windows.
• The installer downloads a static pre-built binary, verifies its checksum, adjusts macOS quarantine flags, and adds the binary to your PATH.
• Supported coding agents are auto-detected and configured unless you pass --skip-config.
• Optional flags include --ui for the visualization server, --skip-config for binary-only installs, and --dir=<path> for custom locations.
• Offline installs are possible by extracting release archives and running the local installer script manually.

Frequently Asked Questions

Does installing DeusData codebase-memory-mcp require compiling from source?

No. The project distributes pre-built static binaries for macOS, Linux, and Windows. You only need to run install.sh or install.ps1 to download and place the binary. If you want to compile manually, the scripts/build.sh script handles the C and tree-sitter build pipeline.

Can I install the tool without modifying my coding agent configuration?

Yes. Pass the --skip-config flag to the installer. This downloads and installs the binary to your PATH without writing to Claude Code, Codex CLI, VS Code, or any other agent configuration files.

How do I access the 3-D codebase visualization after installation?

Install the UI-enabled binary with the --ui flag, then run codebase-memory-mcp --ui=true --port=9749 and open http://localhost:9749 in your browser. This serves the interactive graph interface that visualizes your indexed codebase memory.

What is the default installation directory and can I change it?

The default directory is ~/.local/bin on macOS and Linux, with an equivalent default on Windows. Use the --dir=<path> flag to specify a custom location if your preferred tools directory differs from the default.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}