#1 Persistent memory for AI coding agents based on real-world benchmarks
TypeScript agentmemoryagentsaiclaudeclaudecodecodexcopilotcursorgenaiharnesshermesmemoryompopenclawopencodepi
fix(cli): correct iii install commands — there is no cargo install iii-engine
Rohit Ghumareffca5369903f
diff --git a/README.md b/README.mdindex 9b647b81..2d9ad772 100644--- a/README.md+++ b/README.md@@ -375,20 +375,30 @@ npm install && npm run build && npm startThis starts agentmemory with a local `iii-engine` if `iii` is already installed, or falls back to Docker Compose if Docker is available. REST, streams, and the viewer bind to `127.0.0.1` by default.-Install `iii-engine` manually with `cargo install iii-engine` or follow [iii.dev docs](https://iii.dev/docs).+Install `iii-engine` manually:++- **macOS / Linux:** `curl -fsSL https://install.iii.dev/iii/main/install.sh | sh`+- **Windows:** download `iii-x86_64-pc-windows-msvc.zip` from [iii-hq/iii releases](https://github.com/iii-hq/iii/releases/latest), extract `iii.exe`, add to PATH++Or use Docker (the bundled `docker-compose.yml` pulls `iiidev/iii:latest`). Full docs: [iii.dev/docs](https://iii.dev/docs).### Windows-agentmemory runs on Windows 10/11, but the Node.js package alone isn't enough — you also need the `iii-engine` runtime (a separate Rust binary) as a background process. Pick one of:+agentmemory runs on Windows 10/11, but the Node.js package alone isn't enough — you also need the `iii-engine` runtime (a separate native binary) as a background process. The official upstream installer is a `sh` script and there is no PowerShell installer or scoop/winget package today, so Windows users have two paths:-**Option A — Rust toolchain (recommended):**+**Option A — Prebuilt Windows binary (recommended):**```powershell-# 1. Install rustup: https://rustup.rs/-# 2. Restart your shell so cargo is on PATH-cargo install iii-engine--# 3. Then run agentmemory as usual:+# 1. Open https://github.com/iii-hq/iii/releases/latest in your browser+# 2. Download iii-x86_64-pc-windows-msvc.zip+# (or iii-aarch64-pc-windows-msvc.zip if you're on an ARM machine)+# 3. Extract iii.exe somewhere on PATH, or place it at:+# %USERPROFILE%\.local\bin\iii.exe+# (agentmemory checks that location automatically)+# 4. Verify:+iii --version++# 5. Then run agentmemory as usual:npx -y @agentmemory/agentmemory```@@ -396,12 +406,12 @@ npx -y @agentmemory/agentmemory```powershell# 1. Install Docker Desktop for Windows-# 2. Start Docker Desktop and make sure it says "Engine running"+# 2. Start Docker Desktop and make sure the engine is running# 3. Run agentmemory — it will auto-start the bundled compose file:npx -y @agentmemory/agentmemory```-**Option C — standalone MCP only (no engine):** if you only need the MCP tools for your agent and don't need the REST API / viewer / cron jobs, skip the engine entirely:+**Option C — standalone MCP only (no engine):** if you only need the MCP tools for your agent and don't need the REST API, viewer, or cron jobs, skip the engine entirely:```powershellnpx -y @agentmemory/agentmemory mcp@@ -418,6 +428,8 @@ npx -y agentmemory-mcp| Port conflict | `netstat -ano \| findstr :3111` to see what's bound, then kill it or use `--port <N>` || Docker fallback skipped even though Docker is installed | Make sure Docker Desktop is actually running (system tray icon) |+> Note: there is no `cargo install iii-engine` — `iii` is not published to crates.io. The only supported install methods are the prebuilt binary above, the upstream `sh` install script (macOS/Linux only), and the Docker image.+---<h2 id="why-agentmemory"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/tags/light/section-why.svg"><img src="assets/tags/section-why.svg" alt="Why agentmemory" height="32" /></picture></h2>diff --git a/src/cli.ts b/src/cli.tsindex def5a1cb..0f3699e7 100644--- a/src/cli.ts+++ b/src/cli.ts@@ -97,15 +97,12 @@ function whichBinary(name: string): string | null {function fallbackIiiPaths(): string[] {if (IS_WINDOWS) {const userProfile = process.env["USERPROFILE"] || "";- const localAppData = process.env["LOCALAPPDATA"] || "";return [- join(userProfile, ".cargo", "bin", "iii.exe"),- join(localAppData, "cargo", "bin", "iii.exe"),join(userProfile, ".local", "bin", "iii.exe"),+ join(userProfile, "bin", "iii.exe"),].filter(Boolean);}return [- join(process.env["HOME"] || "", ".cargo", "bin", "iii"),join(process.env["HOME"] || "", ".local", "bin", "iii"),"/usr/local/bin/iii",];@@ -235,14 +232,17 @@ function installInstructions(): string[] {return ["agentmemory requires the `iii-engine` runtime. Pick one:","",- " A) Rust toolchain (recommended):",- " 1. Install rustup: https://rustup.rs/",- " 2. Restart your shell so cargo is on PATH",- " 3. cargo install iii-engine",+ " A) Download the prebuilt Windows binary:",+ " 1. Open https://github.com/iii-hq/iii/releases/latest",+ " 2. Download iii-x86_64-pc-windows-msvc.zip",+ " (or iii-aarch64-pc-windows-msvc.zip on ARM)",+ " 3. Extract iii.exe and either add its folder to PATH",+ " or move it to %USERPROFILE%\\.local\\bin\\iii.exe",+ " 4. Re-run: npx @agentmemory/agentmemory",""," B) Docker Desktop:"," 1. Install Docker Desktop for Windows",- " 2. Start Docker Desktop (make sure the engine is running)",+ " 2. Start Docker Desktop (engine must be running)"," 3. Re-run: npx @agentmemory/agentmemory","","Or skip the engine entirely for standalone MCP:",@@ -252,13 +252,15 @@ function installInstructions(): string[] {return ["agentmemory requires the `iii-engine` runtime. Pick one:","",- " A) cargo install iii-engine",- " (install rustup first if needed: https://rustup.rs/)",+ " A) curl -fsSL https://install.iii.dev/iii/main/install.sh | sh",+ " (installs the prebuilt iii binary into ~/.local/bin/iii)",""," B) Docker: install Docker Desktop or docker-ce, then re-run","","Or skip the engine entirely for standalone MCP:"," npx @agentmemory/agentmemory mcp",+ "",+ "Docs: https://iii.dev/docs",];}@@ -319,9 +321,12 @@ async function main() {p.note(["Common causes:",- " - iii-engine version mismatch (try: cargo install iii-engine --force)",+ " - iii-engine version mismatch — reinstall the latest binary",+ " (sh script on macOS/Linux, GitHub release zip on Windows)"," - Docker Desktop not running (if you're using the Docker path)"," - Port already in use (see below)",+ "",+ "See https://iii.dev/docs for current install instructions.",].join("\n"),"Troubleshooting",);