colony-env CLI¶
colony-env is Colony's local development tool. It manages a Docker Compose cluster with Ray, Redis, PostgreSQL, Kafka, and the Colony web dashboard.
Commands¶
colony-env up¶
Build the Docker image and start the cluster.
colony-env up # 1 worker (default)
colony-env up --workers 3 # 3 Ray workers
colony-env up --no-build # Skip image rebuild
Services started:
| Service | Container | Port |
|---|---|---|
| Ray head | colony-ray-head |
6379, 8265, 10001 |
| Ray workers | colony-ray-worker-N |
— |
| Redis | colony-redis |
6379 |
| PostgreSQL | colony-postgres |
5432 |
| Kafka | colony-kafka |
9092 |
| Dashboard | colony-dashboard |
8080 |
colony-env down¶
Stop and remove all containers and volumes.
colony-env run¶
Execute an analysis inside the cluster.
# Analyze a local codebase
colony-env run --local-repo /path/to/codebase --config analysis.yaml
# With verbose output
colony-env run --local-repo /path/to/codebase --config analysis.yaml --verbose
The local repo is copied to a shared Docker volume and made available to all containers.
colony-env status¶
Show running services and their health.
colony-env dashboard¶
Open the web dashboard in your browser.
colony-env doctor¶
Check prerequisites (Docker, Docker Compose, required files).
Typical Workflow¶
# Full rebuild + run cycle
colony-env down && colony-env up --workers 3 && colony-env run --local-repo /path/to/code --config my_analysis.yaml --verbose
Environment Variables¶
Pass environment variables to the cluster via a .env file or shell exports. Common variables:
| Variable | Description |
|---|---|
ANTHROPIC_API_KEY |
API key for Anthropic Claude |
OPENAI_API_KEY |
API key for OpenAI |
COLONY_DASHBOARD_UI_PORT |
Dashboard port (default: 8080) |
Architecture¶
colony-env uses Docker Compose under the hood. The compose file and Dockerfile are bundled inside the polymathera-colony package at polymathera/colony/cli/deploy/docker/.
The Docker image is based on rayproject/ray:2.49.0-py311-cpu and includes all Colony dependencies plus build tools for the web dashboard frontend.