Skip to main content

Installation

This guide walks you through installing Engram on your system.

Prerequisites​

  • Python 3.13 or higher
  • PostgreSQL 16+ with pgvector extension
  • Docker (recommended for database)

Quick Install​

# Clone the repository
git clone https://github.com/sebastianebg/engram.git
cd engram

# Create virtual environment
uv venv --python 3.13
source .venv/bin/activate

# Install Engram
uv pip install -e .

# For development dependencies
uv pip install -e ".[dev]"

Database Setup​

Start PostgreSQL with pgvector using Docker:

docker compose up -d

Environment Configuration​

Create a .env file with your configuration:

DATABASE_URL=postgresql://engram:engram_dev_password@localhost:5432/engram
AZURE_OPENAI_ENDPOINT=https://your-resource.openai.azure.com
AZURE_OPENAI_API_KEY=your_key
AZURE_EMBEDDING_DEPLOYMENT=text-embedding-3-small
AZURE_CHAT_DEPLOYMENT=gpt-4o

Verify Installation​

engram --help

You should see the available commands listed.

Next Steps​