From 1a09ee8a2b9ab6e42a39880fbbe2a2666500573b Mon Sep 17 00:00:00 2001 From: AndryOre Date: Sun, 13 Sep 2026 10:36:57 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20add=20mise=20install=20m?= =?UTF-8?q?ethod=20to=20the=20installation=20guide?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Added a mise section covering macOS, Linux, and Windows using the registry short name (mise use -g engram@latest) - Documented that mise tracks the stable v1 line and that v2 release candidates are not published to the mise registry - Noted that mise use -g only registers the pin, with mise exec as the fallback when activate or shims are not configured - Corrected the build-from-source requirement from Go 1.24+ to Go 1.25.10 to match go.mod - Linked mise from the README install section Refs #789 Claude-Session: https://claude.ai/code/session_01TrDRDTWjorg5cFCeRxKQLq --- README.md | 2 +- docs/INSTALLATION.md | 23 ++++++++++++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6aeec01b..9902a860 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ Homebrew remains on the stable v1.20.0 line: brew install gentleman-programming/tap/engram ``` -For Windows, Linux, source builds, and all installation methods, see [Installation](docs/INSTALLATION.md). +For Windows, Linux, [mise](https://mise.jdx.dev), source builds, and all installation methods, see [Installation](docs/INSTALLATION.md). ### Set up your agent diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 629c62ed..39aa6885 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -4,6 +4,7 @@ - [Choose a release channel before installing](#choose-a-release-channel-before-installing) - [Homebrew (macOS / Linux)](#homebrew-macos--linux) +- [mise (macOS / Linux / Windows)](#mise-macos--linux--windows) - [Windows](#windows) - [Install from source (macOS / Linux)](#install-from-source-macos--linux) - [Download binary (all platforms)](#download-binary-all-platforms) @@ -40,6 +41,26 @@ brew update && brew upgrade engram --- +## mise (macOS / Linux / Windows) + +[mise](https://mise.jdx.dev) is a polyglot toolchain and version manager. Pin engram with: + +```bash +mise use -g engram@latest +``` + +> **Release channel:** mise tracks the stable v1 line, so `engram@latest` resolves to the latest v1 release. The v2 release candidates are not published to the mise registry, so they cannot be installed this way yet. See [Choose a release channel before installing](#choose-a-release-channel-before-installing). + +> **Note:** `mise use -g` only registers the pin, it does not by itself put `engram` on your `PATH`. You also need either `mise activate` (shell integration, see the [mise docs](https://mise.jdx.dev/getting-started.html)) or shims configured. If you haven't set either up, run engram through mise instead: +> +> ```bash +> mise exec -- engram version +> ``` + +This works the same way on macOS, Linux, and Windows. + +--- + ## Windows **Option A: Install via `go install` (recommended for technical users)** @@ -193,7 +214,7 @@ Grab the latest release for your platform from [GitHub Releases](https://github. ## Requirements -- **Go 1.24+** to build from source (not needed if installing via Homebrew or downloading a binary) +- **Go 1.25.10** to build from source (not needed if installing via Homebrew, mise, or downloading a binary) - That's it. No runtime dependencies. The binary includes SQLite (via [modernc.org/sqlite](https://pkg.go.dev/modernc.org/sqlite) — pure Go, no CGO). Works natively on **macOS**, **Linux**, and **Windows** (x86_64 and ARM64).