Quickstart

1. One-command install (recommended)

Prerequisites: git and uv. Node and pnpm are not required for the CLI — they are only needed for the local dashboard and the TypeScript SDK. The bootstrap prints clear install instructions for either missing tool and exits non-zero rather than partially installing.

# Windows (PowerShell)
irm https://raw.githubusercontent.com/atharvmantri/MemoryGuard/main/scripts/install.ps1 | iex

# macOS / Linux
curl -fsSL https://raw.githubusercontent.com/atharvmantri/MemoryGuard/main/scripts/install.sh | bash

After this finishes, the wrapper is on your PATH and memoryguard doctor plus memoryguard demo work from any shell, including protected cwds like C:\\Windows\\System32.

2. Use the memoryguard command directly

memoryguard doctor
memoryguard demo
memoryguard init
memoryguard remember "This project uses Flask for the backend."
memoryguard sync
memoryguard status

memoryguard doctor prints a pass / warn / error table that confirms the install, the Python environment, the local store, and the optional tools. memoryguard demo runs the Agent Capture flow against a temporary project and then cleans itself up.

3. Agent Capture in one project

memoryguard capture file ./codex-session.txt --source codex
memoryguard capture pending
memoryguard capture approve --all
memoryguard sync

4. Uninstall the wrapper

The uninstaller removes the wrapper files (and the persistent user-PATH entry the installer added). User project .memoryguard/ stores are never touched. Add -RemoveSource / --remove-source to also delete the cloned source directory.

# Windows
powershell -ExecutionPolicy Bypass -File "$env:LOCALAPPDATA\MemoryGuard\source\scripts\uninstall.ps1"

# macOS / Linux
bash ~/.local/share/memoryguard/source/scripts/uninstall.sh

Troubleshooting PATH

If memoryguard does not resolve in a new shell, check which one Windows or POSIX is finding first:

# Windows PowerShell
Get-Command memoryguard -All

# cmd.exe
where memoryguard

Expected: %LOCALAPPDATA%\\Programs\\MemoryGuard\\memoryguard.cmd (or memoryguard.ps1).

If a stale memoryguard.exe from a prior Python install (e.g. C:\\Users\\<you>\\AppData\\Local\\Programs\\Python\\Python312\\Scripts\\memoryguard.exe) still wins on PATH, re-run the install with -RemoveShadowingCommands to move the offending file out of the way automatically.

Advanced: from source without the wrapper

If you would rather not install the wrapper, every command also works directly with uv run from a clone of the repo:

git clone https://github.com/atharvmantri/MemoryGuard.git
cd MemoryGuard
uv run memoryguard demo

This is the path used during active development. See CONTRIBUTING.md for the full dev loop, including the MCP server, the REST API, and the local dashboard.