mentedb

(β˜… 116)

A cognition aware database engine for AI agent memory. Purpose built in Rust with WAL, HNSW, knowledge graphs, and speculative context pre assembly. Not a wrapper, a ground up storage engine that thinks.

  • .dockerignore
  • .gitignore
  • ARCHITECTURE.md
  • Cargo.lock
  • Cargo.toml
  • CHANGELOG.md
  • CLAUDE.md
  • CONTRIBUTING.md
  • docker-compose.yml
  • Dockerfile
  • LICENSE
  • README.md
  • release-plz.toml
  • release.toml
  • test_context_embeddings.py
  • test_pipeline_audit.py
  • VISION.md

# Installation Guide

1. Get the code
git clone https://github.com/nambok/mentedb

Downloads the entire project code from GitHub to your computer.

cd mentedb

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
cargo install mentedb-server

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

pip install mentedb

Installs the package published on PyPI directly β€” no need to clone the source.

pip install mentedb-langchain # LangChain memory provider

Installs the package published on PyPI directly β€” no need to clone the source.

pip install mentedb-crewai # CrewAI memory provider

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker run -p 6677:6677 \

Runs the built image as an actual container.

docker compose -f observability/docker-compose.yml up -d

Runs the command against the services defined in the compose file.

docker build -t mentedb .

Builds a runnable image based on the Dockerfile.

docker-compose up -d

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install mentedb

Downloads and installs the libraries listed in package.json.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install mentedb

Installs the package published on PyPI directly β€” no need to clone the source.

python3 -m venv .venv && .venv/bin/pip install mentedb

Installs the Python libraries listed in requirements.txt (or similar).

pip install mentedb-langchain # LangChain memory provider

Installs the package published on PyPI directly β€” no need to clone the source.

pip install mentedb-crewai # CrewAI memory provider

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

6. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install mentedb-server

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo install mentedb-mcp

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

cargo run -p mentedb-server -- --data-dir ./data --jwt-secret-file ./secret.key

Builds and then immediately runs the program.

// Enable enrichment in Cargo.toml:

Type this command into your terminal and run it.

cargo test -p mentedb-extraction --test llm_accuracy -- --ignored --nocapture

Type this command into your terminal and run it.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation