Skip to content

docs: clarify install-from-source PATH and Claude Code CLI version #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Kevinsillo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify install-from-source PATH and Claude Code CLI version #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 24 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,20 @@ Expand-Archive engram_*_windows_amd64.zip -DestinationPath "$env:USERPROFILE\bin
```powershell
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: build with version stamp (otherwise `engram version` shows "dev")
# Option A: Install directly with version stamp (Recommended)
go install -ldflags="-X main.version=$(git describe --tags --always)" ./cmd/engram

# Option B: Build and move to PATH manually
$v = git describe --tags --always
go build -ldflags="-X main.version=local-$v" -o engram.exe ./cmd/engram
go build -ldflags="-X main.version=$v" -o engram.exe ./cmd/engram
# Move to a directory in your PATH (e.g., %USERPROFILE%\bin)
```

> **Version stamp:** Without the `-ldflags` flag, `engram version` shows "dev". Use either option above to embed the git version.
>
> **Important:** `go install` places the binary in `%GOPATH%\bin` (usually `%USERPROFILE%\go\bin`), which must be in your `PATH`. `go build -o engram.exe` creates the binary in the current directory — move it to a directory in your `PATH` or it won't be found. If `engram version` still shows "dev" after building, you're likely running an older copy from `%GOPATH%\bin` — check with `where engram`.

> **Windows notes:**
> - Data is stored in `%USERPROFILE%\.engram\engram.db`
> - Override with `ENGRAM_DATA_DIR` environment variable
Expand All @@ -92,12 +98,18 @@ go build -ldflags="-X main.version=local-$v" -o engram.exe ./cmd/engram
```bash
git clone https://github.com/Gentleman-Programming/engram.git
cd engram
go install ./cmd/engram

# Optional: build with version stamp (otherwise `engram version` shows "dev")
go build -ldflags="-X main.version=local-$(git describe --tags --always)" -o engram ./cmd/engram
# Option A: Install directly with version stamp (Recommended)
go install -ldflags="-X main.version=$(git describe --tags --always)" ./cmd/engram

# Option B: Build and move to PATH manually
go build -ldflags="-X main.version=$(git describe --tags --always)" -o /usr/local/bin/engram ./cmd/engram
```

> **Version stamp:** Without the `-ldflags` flag, `engram version` shows "dev". Use either option above to embed the git version.
>
> **Important:** `go install` places the binary in `$GOPATH/bin` (usually `~/go/bin`), which must be in your `PATH`. `go build -o engram` creates the binary in the current directory — move it to a directory in your `PATH` (e.g. `/usr/local/bin/`) or it won't be found. If `engram version` still shows "dev" after building, you're likely running an older copy from `$GOPATH/bin` — check with `which engram`.

### Download binary (all platforms)

Grab the latest release for your platform from [GitHub Releases](https://github.com/Gentleman-Programming/engram/releases).
Expand Down Expand Up @@ -277,6 +289,11 @@ See [OpenCode Plugin](#opencode-plugin) for details on what the plugin provides

> **Prerequisite**: Install the `engram` binary first (via [Homebrew](#install-via-homebrew-macOS--linux), [Windows binary](#install-on-windows), [binary download](#download-binary-all-platforms), or [source](#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
Expand Down