Installation
PRX-Memory is distributed as a Rust workspace. The primary artifact is the prx-memoryd daemon binary from the prx-memory-mcp crate.
Recommended
Building from source gives you the latest features and allows you to enable optional backends like LanceDB.
Prerequisites
| Requirement | Minimum | Notes |
|---|---|---|
| Rust | stable toolchain | Install via rustup |
| Operating System | Linux, macOS, Windows (WSL2) | Any platform supported by Rust |
| Git | 2.30+ | For cloning the repository |
| Disk Space | 100 MB | Binary + dependencies |
| RAM | 256 MB | More recommended for large memory databases |
Method 1: Build from Source (Recommended)
Clone the repository and build in release mode:
git clone https://github.com/openprx/prx-memory.git
cd prx-memory
cargo build --release -p prx-memory-mcp --bin prx-memorydThe binary is located at target/release/prx-memoryd. Copy it to your PATH:
sudo cp target/release/prx-memoryd /usr/local/bin/prx-memorydBuild Options
| Feature Flag | Default | Description |
|---|---|---|
lancedb-backend | disabled | LanceDB vector storage backend |
To build with LanceDB support:
cargo build --release -p prx-memory-mcp --bin prx-memoryd --features lancedb-backendBuild Dependencies
On Debian/Ubuntu you may need:
sudo apt install -y build-essential pkg-config libssl-devOn macOS, Xcode Command Line Tools are required:
xcode-select --installMethod 2: Cargo Install
If you have Rust installed, you can install directly:
cargo install prx-memory-mcpThis compiles from source and places the prx-memoryd binary in ~/.cargo/bin/.
Method 3: Use as Library
To use PRX-Memory crates as dependencies in your own Rust project, add them to your Cargo.toml:
[dependencies]
prx-memory-core = "0.1"
prx-memory-embed = "0.1"
prx-memory-rerank = "0.1"
prx-memory-storage = "0.1"Verify Installation
After building, verify the binary runs:
prx-memoryd --helpTest a basic stdio session:
PRX_MEMORYD_TRANSPORT=stdio \
PRX_MEMORY_DB=./data/memory-db.json \
prx-memorydTest an HTTP session:
PRX_MEMORYD_TRANSPORT=http \
PRX_MEMORY_HTTP_ADDR=127.0.0.1:8787 \
PRX_MEMORY_DB=./data/memory-db.json \
prx-memorydCheck the health endpoint:
curl -sS http://127.0.0.1:8787/healthDevelopment Setup
For development and testing, use the standard Rust workflow:
# Format
cargo fmt --all
# Lint
cargo clippy --all-targets --all-features -- -D warnings
# Test
cargo test --all-targets --all-features
# Check (fast feedback)
cargo check --all-targets --all-featuresUninstalling
# Remove the binary
sudo rm /usr/local/bin/prx-memoryd
# Or if installed via Cargo
cargo uninstall prx-memory-mcp
# Remove data files
rm -rf ./data/memory-db.jsonNext Steps
- Quick Start -- Get PRX-Memory running in 5 minutes
- Configuration -- All environment variables and profiles
- MCP Integration -- Connect to your MCP client