Skip to content

Installation

bash
pipx install hebb-mind

Requires Python >= 3.10. No external database needed — SQLite is built in.

pipx installs hebb-mind into its own isolated virtualenv and links the hebb / hebb-mcp entry points onto your PATH automatically. It's the modern default for Python CLI tools and avoids the two long-standing footguns of pip install --user (PATH not updated, PEP 668 on Homebrew / Debian-family Python).

Install pipx if you don't have it

Run one block that matches your OS, then open a new terminal so the updated PATH takes effect.

bash
brew install pipx
pipx ensurepath
bash
sudo apt install pipx       # Ubuntu 23.04+ / Debian 12+
pipx ensurepath
bash
sudo dnf install pipx
pipx ensurepath
powershell
python -m pip install --user pipx
python -m pipx ensurepath
bash
python -m pip install --user pipx
python -m pipx ensurepath

After ensurepath writes to your shell rc / Windows user PATH, open a new terminal and re-run pipx install hebb-mind.

To upgrade later: pipx upgrade hebb-mind. To remove cleanly: pipx uninstall hebb-mind.

Alternative: virtualenv + pip

If you already work inside a virtualenv (or want to manage everything yourself):

bash
python3 -m venv .venv
source .venv/bin/activate          # Windows: .venv\Scripts\activate
pip install -U hebb-mind           # `hebb` lives on the venv's PATH

System-wide installs via sudo pip install work but are increasingly blocked by PEP 668 on modern distros; pipx is the supported path going forward.

Setup

bash
hebb setup

Creates hebb.json and hebb.db, selects the default embedding model, selects the download source, and verifies the model. It does not start a background service.

Verify

bash
hebb --version
hebb model status
hebb service install

Open http://localhost:8321/ for the Web Console, or http://localhost:8321/docs for the API docs.

Docker

bash
git clone https://github.com/afx-team/hebb-mind.git && cd hebb-mind
docker compose -f docker/docker-compose.yml up

PostgreSQL Backend

For production workloads, switch to PostgreSQL + pgvector:

bash
pipx install 'hebb-mind[pg]'    # or: pipx inject hebb-mind 'hebb-mind[pg]' --force
hebb config set storage_type postgresql
hebb config set pg_url postgresql://user:pass@localhost/hebb

See Storage Backends for details.

Next Steps

Released under the MIT License.