Skip to content

Requirements

The CLI requires Node.js. The worker agent is a standalone Go binary with no runtime dependencies.

ComponentRequirementMinimumRecommended
CLINode.js22+Latest LTS
CLInpm10+Latest
Worker agent(none)
BothContainer runtimePodman 4+ or Docker 24+Podman 5+
BothOSmacOS 13+, Windows 10+, Ubuntu 22.04+Latest stable

The worker agent auto-detects Podman and Docker via PATH — install either one (or both).

  • WSL2 is required for Podman on Windows
  • Run wsl --install if not already configured
  • The cropscode doctor command checks WSL status automatically
ResourceMinimumRecommended
RAM4 GB free8+ GB free
Disk20 GB free50+ GB free
CPU2 cores4+ cores

Container images are ~2-4 GB each. Running multiple containers simultaneously requires proportionally more resources.

RequirementDetails
DirectionOutbound only — no inbound ports needed
ProtocolWebSocket (WSS on port 443)
FirewallMust allow outbound HTTPS/WSS
NATWorks behind NAT routers
ProxyHTTP proxies supported via standard env vars

Workers connect outbound to the orchestrator. No port forwarding, no static IP, no DNS required on the worker side.

Terminal window
# macOS
brew install podman
podman machine init
podman machine start
# Ubuntu/Debian
sudo apt-get install podman
# Windows (requires WSL2)
winget install RedHat.Podman
podman machine init
podman machine start

Docker Desktop works but is not recommended for production workers due to licensing requirements. Podman is rootless and license-free.

Run the health check to verify all requirements:

Terminal window
cropscode doctor
Getting Started Concepts Guides CLI Self-Hosting Reference Links