Skip to content

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

Open
Kevinsillo wants to merge 1 commit intoGentleman-Programming:mainfrom
Kevinsillo:fix/docs-install-version-stamp
Open

docs: fix build-from-source instructions and add Claude CLI version note#110
Kevinsillo wants to merge 1 commit intoGentleman-Programming:mainfrom
Kevinsillo:fix/docs-install-version-stamp

Conversation

@Kevinsillo
Copy link

@Kevinsillo Kevinsillo commented Mar 21, 2026

Summary

  • INSTALLATION.md: Split the optional version-stamp step into separate, copy-pasteable code blocks (go build for local testing vs go install for system-wide install). Previously go build -o engram left the versioned binary in the current directory without installing it — users who followed the "optional" step ended up with a stale binary in $GOPATH/bin.
  • AGENT-SETUP.md & PLUGINS.md: Add a note about the minimum Claude Code CLI version required (>= 2.1.70) for the marketplace plugin. Older versions fail with Invalid schema: plugins.0.source: Invalid input.

Closes #67

Test plan

  • Verify the go install -ldflags command works and places the versioned binary in $GOPATH/bin
  • Verify the go build -ldflags command builds the binary in the current directory
  • Confirm the Claude CLI version note renders correctly in both docs

- 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
Copilot AI review requested due to automatic review settings March 21, 2026 19:20
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates documentation to prevent common install-from-source pitfalls (stale/unversioned binaries) and to clarify a Claude Code CLI minimum version needed for marketplace plugin installation.

Changes:

  • Split the “optional version stamp” step into two copy/paste flows: go build (local binary) vs go install (installs into GOBATH/bin / GOBIN).
  • Add a minimum Claude Code CLI version note (>= 2.1.70) and the associated error users may see on older versions.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/INSTALLATION.md Clarifies build-vs-install behavior and provides separate version-stamped commands for local testing vs system-wide install.
docs/AGENT-SETUP.md Adds Claude Code CLI minimum version note near marketplace plugin instructions.
docs/PLUGINS.md Adds the same Claude Code CLI minimum version note in the Claude Code plugin section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: clarify install-from-source version stamp and Claude Code CLI minimum version

2 participants