From e29b2539ea5c2b3b3f9a88fb4e33575868c79371 Mon Sep 17 00:00:00 2001 From: Kevin Illanas Date: Sat, 21 Mar 2026 19:19:07 +0000 Subject: [PATCH] docs: fix build-from-source instructions and add Claude CLI version note MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Split optional version-stamp commands into separate copy-pasteable blocks (build-only vs build-and-install) so users don't accidentally run both at once - Replace `go build` with `go install` for the install path, so the versioned binary actually lands in $GOPATH/bin instead of the current directory - Add minimum Claude Code CLI version note (>= 2.1.70) to AGENT-SETUP and PLUGINS docs — older versions fail with a schema validation error when adding the marketplace plugin --- docs/AGENT-SETUP.md | 5 +++++ docs/INSTALLATION.md | 27 +++++++++++++++++++++++++-- docs/PLUGINS.md | 7 ++++++- 3 files changed, 36 insertions(+), 3 deletions(-) diff --git a/docs/AGENT-SETUP.md b/docs/AGENT-SETUP.md index 5629adb..8fa78c1 100644 --- a/docs/AGENT-SETUP.md +++ b/docs/AGENT-SETUP.md @@ -66,6 +66,11 @@ See [Plugins → OpenCode Plugin](PLUGINS.md#opencode-plugin) for details on wha > **Prerequisite**: Install the `engram` binary first (via [Homebrew](INSTALLATION.md#homebrew-macos--linux), [Windows binary](INSTALLATION.md#windows), [binary download](INSTALLATION.md#download-binary-all-platforms), or [source](INSTALLATION.md#install-from-source-macos--linux)). The plugin needs it for the MCP server and session tracking scripts. +> **Minimum CLI version:** The marketplace plugin requires **Claude Code CLI >= 2.1.70**. Check with `claude --version` and update with `claude update` if needed. Older versions fail with: +> ``` +> ✘ Failed to add marketplace: Invalid schema: plugins.0.source: Invalid input +> ``` + **Option A: Plugin via marketplace (recommended)** — full session management, auto-import, compaction recovery, and Memory Protocol skill: ```bash diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 5436ac6..9348985 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -51,12 +51,24 @@ git clone https://github.com/Gentleman-Programming/engram.git cd engram go install ./cmd/engram # Binary goes to %GOPATH%\bin\engram.exe (typically %USERPROFILE%\go\bin\) +``` + +> **Optional:** add a version stamp (otherwise `engram version` shows "dev") + +Build only (binary stays in the current directory): -# Optional: build with version stamp (otherwise `engram version` shows "dev") +```powershell $v = git describe --tags --always go build -ldflags="-X main.version=local-$v" -o engram.exe ./cmd/engram ``` +Build and install to `%GOPATH%\bin` so it's available system-wide: + +```powershell +$v = git describe --tags --always +go install -ldflags="-X main.version=local-$v" ./cmd/engram +``` + **Option C: Download the prebuilt binary** 1. Go to [GitHub Releases](https://github.com/Gentleman-Programming/engram/releases) @@ -104,11 +116,22 @@ Expand-Archive engram_*_windows_amd64.zip -DestinationPath "$env:USERPROFILE\bin git clone https://github.com/Gentleman-Programming/engram.git cd engram go install ./cmd/engram +``` + +> **Optional:** add a version stamp (otherwise `engram version` shows "dev") -# Optional: build with version stamp (otherwise `engram version` shows "dev") +Build only (binary stays in the current directory): + +```bash go build -ldflags="-X main.version=local-$(git describe --tags --always)" -o engram ./cmd/engram ``` +Build and install to `$GOPATH/bin` so it's available system-wide: + +```bash +go install -ldflags="-X main.version=local-$(git describe --tags --always)" ./cmd/engram +``` + --- ## Download binary (all platforms) diff --git a/docs/PLUGINS.md b/docs/PLUGINS.md index 45eddad..0e0022a 100644 --- a/docs/PLUGINS.md +++ b/docs/PLUGINS.md @@ -59,7 +59,12 @@ The OpenCode plugin uses a defense-in-depth strategy to ensure memories survive ## Claude Code Plugin -For [Claude Code](https://docs.anthropic.com/en/docs/claude-code) users, a plugin adds enhanced session management using Claude's native hook and skill system: +For [Claude Code](https://docs.anthropic.com/en/docs/claude-code) users, a plugin adds enhanced session management using Claude's native hook and skill system. + +> **Minimum CLI version:** The marketplace plugin requires **Claude Code CLI >= 2.1.70**. Check with `claude --version` and update with `claude update` if needed. Older versions fail with: +> ``` +> ✘ Failed to add marketplace: Invalid schema: plugins.0.source: Invalid input +> ``` ```bash # Install via Claude Code marketplace (recommended)