Skip to content

Commit bcf594f

Browse files
committed
README: update install docs with --skip-config, archive install scripts, Windows
1 parent b31d177 commit bcf594f

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,29 +48,34 @@ curl -fsSL https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/i
4848
powershell -ExecutionPolicy ByPass -c "irm https://raw.githubusercontent.com/DeusData/codebase-memory-mcp/main/install.ps1 | iex"
4949
```
5050

51+
Options: `--ui` (graph visualization), `--skip-config` (binary only, no agent setup), `--dir=<path>` (custom location).
52+
5153
Restart your coding agent. Say **"Index this project"** — done.
5254

5355
<details>
5456
<summary>Manual install</summary>
5557

56-
1. **Download** the binary for your platform from the [latest release](https://github.com/DeusData/codebase-memory-mcp/releases/latest):
57-
- `codebase-memory-mcp-<os>-<arch>.tar.gz` — standard (MCP server only)
58-
- `codebase-memory-mcp-ui-<os>-<arch>.tar.gz` — with embedded graph visualization
58+
1. **Download** the archive for your platform from the [latest release](https://github.com/DeusData/codebase-memory-mcp/releases/latest):
59+
- `codebase-memory-mcp-<os>-<arch>.tar.gz` (macOS/Linux) or `.zip` (Windows) — standard
60+
- `codebase-memory-mcp-ui-<os>-<arch>.tar.gz` / `.zip` — with graph visualization
61+
62+
2. **Extract and install** (each archive includes `install.sh` or `install.ps1`):
5963

60-
2. **Extract and install**:
64+
macOS / Linux:
6165
```bash
6266
tar xzf codebase-memory-mcp-*.tar.gz
63-
mv codebase-memory-mcp ~/.local/bin/
64-
codebase-memory-mcp install
67+
./install.sh
68+
```
69+
70+
Windows (PowerShell):
71+
```powershell
72+
Expand-Archive codebase-memory-mcp-windows-amd64.zip -DestinationPath .
73+
.\install.ps1
6574
```
6675

6776
3. **Restart** your coding agent.
6877

69-
On macOS, if the binary is killed on launch, fix code signing:
70-
```bash
71-
xattr -d com.apple.quarantine ~/.local/bin/codebase-memory-mcp
72-
codesign --sign - --force ~/.local/bin/codebase-memory-mcp
73-
```
78+
The `install` command automatically strips macOS quarantine attributes and ad-hoc signs the binary — no manual `xattr`/`codesign` needed.
7479
</details>
7580

7681
The `install` command auto-detects all installed coding agents and configures MCP server entries, instruction files, skills, and pre-tool hooks for each.

0 commit comments

Comments
 (0)