mirror of
https://github.com/DeusData/codebase-memory-mcp.git
synced 2026-11-04 10:48:20 +00:00
docs(readme): single-binary layout, Windows update flow, current test count
- Windows updates run from install.ps1, not the running binary: a running executable cannot replace its own image on Windows. Document the exact command, that re-running the script IS the update, and the Unblock-File caveat for Mark-of-the-Web. npm/pip users keep updating via their package manager on every platform. - Build from source: state that every platform produces ONE self-contained binary with no companion executables, and document how to run the suite (scripts/test.sh, the same entry the CI gates use) and how to package an archive locally with the canonical script. - Test badge 5604 -> 6768, the current count from build/c/test-runner. Signed-off-by: Martin Vogel <martin.vogel.tech@gmail.com>
This commit is contained in:
1 parent
a54ea95719
commit
395f6efa42
1 file changed
+30
-2
@@ -3,7 +3,7 @@
|
||||
[](https://github.com/DeusData/codebase-memory-mcp/releases/latest)
|
||||
[](LICENSE)
|
||||
[](https://github.com/DeusData/codebase-memory-mcp/actions/workflows/dry-run.yml)
|
||||
[](https://github.com/DeusData/codebase-memory-mcp)
|
||||
[](https://github.com/DeusData/codebase-memory-mcp)
|
||||
[](https://github.com/DeusData/codebase-memory-mcp)
|
||||
[](#hybrid-lsp)
|
||||
[](https://github.com/DeusData/codebase-memory-mcp)
|
||||
@@ -155,10 +155,22 @@ Watcher registration is controlled separately by `auto_watch` (default `true`).
|
||||
|
||||
### Keeping Up to Date
|
||||
|
||||
**macOS / Linux:**
|
||||
|
||||
```bash
|
||||
codebase-memory-mcp update
|
||||
```
|
||||
|
||||
**Windows** — updates run from `install.ps1`, not from the running binary, because a running executable cannot replace its own image on Windows. `codebase-memory-mcp update` prints the exact command; it is:
|
||||
|
||||
```powershell
|
||||
powershell -ExecutionPolicy Bypass -File "<install-dir>\install.ps1"
|
||||
```
|
||||
|
||||
`install.ps1` is idempotent, so re-running it *is* the update: it stops the daemon, retires the running binary, installs the new one, and cleans up. `install.ps1` sits next to the binary in your install directory. If PowerShell refuses to run it because the file came from the internet, `Unblock-File` it first.
|
||||
|
||||
Installed through **npm or pip**? Update with your package manager on every platform (`npm install -g codebase-memory-mcp@latest` / `pip install -U codebase-memory-mcp`).
|
||||
|
||||
The MCP server also checks for updates on startup and notifies on the first tool call if a newer release is available.
|
||||
|
||||
### Uninstall
|
||||
@@ -359,7 +371,23 @@ git clone https://github.com/DeusData/codebase-memory-mcp.git
|
||||
cd codebase-memory-mcp
|
||||
scripts/build.sh # standard binary
|
||||
scripts/build.sh --with-ui # with graph visualization
|
||||
# Binary at: build/c/codebase-memory-mcp
|
||||
# Binary at: build/c/codebase-memory-mcp (codebase-memory-mcp.exe on Windows)
|
||||
```
|
||||
|
||||
Every platform builds **one self-contained binary** — no runtime dependencies, no companion executables to keep alongside it.
|
||||
|
||||
Run the test suite (6,768 tests across 120 suites):
|
||||
|
||||
```bash
|
||||
scripts/test.sh # full: clean sanitizer build + all suites + guards
|
||||
scripts/test.sh --suites <name> # one suite, incremental, seconds
|
||||
build/c/test-runner --list-suites # what is available
|
||||
```
|
||||
|
||||
`scripts/test.sh` is the same entry the CI gates run, so a local pass means the same thing a CI pass does. Packaging a release archive locally uses the same canonical script the release pipeline calls:
|
||||
|
||||
```bash
|
||||
scripts/package-release.sh <linux|darwin|windows> <amd64|arm64>
|
||||
```
|
||||
|
||||
### Manual MCP Configuration
|
||||
|
||||
Reference in new issue
Block a user