Prerequisites
Before developing or contributing to PutmeIn, ensure your workstation meets the necessary toolchains and runtime requirements.
Baseline Requirements
| Dependency | Minimum Version | Recommended | Notes |
|---|---|---|---|
| Node.js | >= 20.0.0 | Node 22 (LTS) | Required across all frontend, CLI wrapper, and documentation packages. |
| npm | >= 9.0.0 | Latest LTS | Standard package manager for monorepo dependency coordination. |
| Go | >= 1.22 | Go 1.22+ | Required for compiling the Brain AI daemon and Cohen TUI client. |
| Docker | Latest stable | Docker Engine + Compose | Required for container management and local infrastructure orchestration. |
| Git | >= 2.30 | Latest | Version control and collaborative workflows. |
Operating System Compatibility
PutmeIn actively supports macOS (Apple Silicon and Intel), Linux (Debian, Ubuntu, Arch, Fedora, CentOS), and Windows (via native PowerShell or WSL2).
Toolchain Details
1. Node.js & npm
The monorepo contains multiple JavaScript/TypeScript packages (ray, landing, docs, and root scripts):
- Recommended Version: Node 22 LTS (
>= 20.0.0). - While the repository root allows
>= 18.0.0, thedocspackage specifies>= 20.0.0and thelandingpackage is aligned with Node22.20.0(with.nvmrcset to22). - To ensure seamless compilation across every package without engine mismatch warnings, installing Node 20 or Node 22 is strongly recommended.
- Verify your installed version:
node -vnpm -v
2. Go
The Brain background engine (/brain) and the Cohen terminal user interface (/cohen) are implemented in Go:
- Required Version: Go 1.22 or higher.
- Both
brain/go.modandcohen/go.modrequire Go 1.22 language semantics. - Verify your installed version:
go version
3. Docker & Container Runtime
PutmeIn monitors and orchestrates Docker containers autonomously:
- Install Docker Desktop (macOS / Windows) or Docker Engine with Docker Compose (Linux).
- Ensure the Docker daemon is running and your user has permissions to access the Docker socket:
docker ps
Next Steps
Once your prerequisites are satisfied, proceed to Setting up the Project to clone the repository and configure your local workspace.