You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 1edccf3
Browse filesBrowse the repository at this point in the historyBrowse files
Martin Vogel
committed
Rewrite installation docs for binary-first onboarding
Lead with pre-built binary download (no toolchain needed), then setup
scripts for automation, then build-from-source for contributors.
- Add platform table with all 5 targets including linux-arm64
- Add Windows SmartScreen guidance for unsigned binary
- Document checksums.txt for integrity verification
- Credit @Flipper1994 for WSL2 workaround (closes#1)
Copy file name to clipboardExpand all lines: README.md
+94-33Lines changed: 94 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,92 +47,153 @@ Claude Code formats and explains the results.
47
47
48
48
## Installation
49
49
50
-
### Quick Install via Claude Code
50
+
### Just Want to Get Started?
51
51
52
-
The fastest way: paste the repo URL directly into Claude Code and ask it to install:
52
+
Grab a pre-built binary from the [latest release](https://github.com/DeusData/codebase-memory-mcp/releases/latest) — no Go, no compiler, no git needed.
| Linux (x86_64) |`codebase-memory-mcp-linux-amd64.tar.gz`|
59
+
| Linux (ARM64 / Graviton) |`codebase-memory-mcp-linux-arm64.tar.gz`|
60
+
| Windows (x86_64) |`codebase-memory-mcp-windows-amd64.zip`|
61
+
62
+
Every release includes a `checksums.txt` with SHA-256 hashes for verification.
63
+
64
+
**3 steps:**
65
+
66
+
1.**Download and extract** the binary for your platform
67
+
2.**Put it somewhere on your PATH** (e.g. `~/.local/bin/` on macOS/Linux, or any folder on Windows)
68
+
3.**Tell Claude Code about it** — add to `.mcp.json` in your project root:
69
+
```json
70
+
{
71
+
"mcpServers": {
72
+
"codebase-memory-mcp": {
73
+
"type": "stdio",
74
+
"command": "/path/to/codebase-memory-mcp"
75
+
}
76
+
}
77
+
}
78
+
```
79
+
80
+
Restart Claude Code, verify with `/mcp`, then say **"Index this project"** — done.
81
+
82
+
> **Windows note**: Windows SmartScreen may show "Windows protected your PC" when you first run the binary. This is normal for unsigned open-source software. Click **"More info"** then **"Run anyway"**. You can verify the binary integrity using the `checksums.txt` file included in each release.
83
+
84
+
### Setup Scripts (Automated)
85
+
86
+
The setup scripts automate download, placement, and Claude Code configuration.
0 commit comments