Skip to content

docs: fix build-from-source instructions and add Claude CLI version note #110

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
+36 −3
Open

docs: fix build-from-source instructions and add Claude CLI version note #110

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions docs/AGENT-SETUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
27 changes: 25 additions & 2 deletions docs/INSTALLATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
7 changes: 6 additions & 1 deletion docs/PLUGINS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading