📦 Installation

Install SpecMem using your preferred package manager.

Basic Installation

pipuvpipx

pip install specmem

uv pip install specmem

pipx install specmem

Optional Dependencies

SpecMem supports various optional features. Install them based on your needs:

☁️ Cloud Embedding Providers

OpenAIGoogleTogether AIAll Providers

pip install "specmem[openai]"

pip install "specmem[google]"

pip install "specmem[together]"

pip install "specmem[cloud]"

🗄️ Alternative Vector Stores

ChromaDBQdrant

pip install "specmem[chroma]"

pip install "specmem[qdrant]"

🌐 Web UI

pip install "specmem[ui]"

🔧 Development

pip install "specmem[dev]"

📚 Documentation

pip install "specmem[docs]"

🎯 Everything

pip install "specmem[all]"

Verify Installation

After installation, verify SpecMem is working:

specmem --version

Expected output:

SpecMem v0.1.0

From Source

For the latest development version:

git clone https://github.com/Shashikant86/specmem.git
cd specmem
pip install -e ".[dev]"

Docker

Run SpecMem in a container:

docker run -v $(pwd):/workspace ghcr.io/shashikant86/specmem:latest scan

Troubleshooting

Common Issues

Python Version

SpecMem requires Python 3.11 or higher. Check your version:

python --version

Virtual Environment

We recommend using a virtual environment:

python -m venv .venv
source .venv/bin/activate  # macOS/Linux
.venv\Scripts\activate     # Windows
pip install specmem

Apple Silicon

On Apple Silicon Macs, some dependencies may need Rosetta:

arch -x86_64 pip install specmem

Next Steps

Once installed, proceed to the Quick Start guide.