Skip to main content

Installation

This guide covers installing Caracal Core and its dependencies.

Prerequisites​

  • Python 3.10+
  • Docker and Docker Compose (for containerized deployment)
  • PostgreSQL 14+ (database)
  • Redis 7+ (optional, for real-time metrics)
  • Kafka (optional, for event-driven architecture)

Installation Methods​

Option 1: pip (Development)​

pip install caracal-core
git clone https://github.com/Garudex-Labs/Caracal.git
cd Caracal
docker-compose up -d

Option 3: From Source​

git clone https://github.com/Garudex-Labs/Caracal.git
cd Caracal
pip install -e .

Verifying Installation​

caracal --version

Next Steps​