Installation¶
This guide covers how to install Hayhooks and its dependencies.
System Requirements¶
- Python 3.9+
- Operating System: Linux, macOS, or Windows
- Memory: Minimum 512MB RAM, 2GB+ recommended
- Storage: Minimum 100MB free space
Install from PyPI¶
pip install hayhooks
This includes all core features for deploying and running pipelines.
pip install hayhooks[mcp]
Includes all standard features plus MCP Server support for integration with AI development tools like Cursor and Claude Desktop.
Python 3.10+ Required
You'll need to run at least Python 3.10+ to use the MCP Server.
git clone https://github.com/deepset-ai/hayhooks.git
cd hayhooks
pip install -e .
Useful for development or testing the latest unreleased features.
Verify Installation¶
After installation, verify that Hayhooks is installed correctly:
# Check version
hayhooks --version
# Show help
hayhooks --help
Development Installation¶
If you want to contribute to Hayhooks, clone the repository and install in editable mode:
# Clone the repository
git clone https://github.com/deepset-ai/hayhooks.git
cd hayhooks
# Create a virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install in development mode
pip install -e .
Docker Installation¶
Using Docker Hub¶
# Pull the latest image
docker pull deepset/hayhooks:latest
# Run Hayhooks
docker run -p 1416:1416 deepset/hayhooks:latest
Building from Source¶
# Clone the repository
git clone https://github.com/deepset-ai/hayhooks.git
cd hayhooks
# Build with Docker Buildx Bake (current platform) and load into Docker
cd docker
IMAGE_NAME=hayhooks IMAGE_TAG_SUFFIX=local docker buildx bake --load
# Run the image
docker run -p 1416:1416 hayhooks:local
Next Steps¶
After successful installation:
- Quick Start - Get started with basic usage
- Configuration - Configure Hayhooks for your needs
- Examples - Explore example implementations