Skip to main content

Prerequisites

Before developing or contributing to PutmeIn, ensure your workstation meets the necessary toolchains and runtime requirements.


Baseline Requirements

DependencyMinimum VersionRecommendedNotes
Node.js>= 20.0.0Node 22 (LTS)Required across all frontend, CLI wrapper, and documentation packages.
npm>= 9.0.0Latest LTSStandard package manager for monorepo dependency coordination.
Go>= 1.22Go 1.22+Required for compiling the Brain AI daemon and Cohen TUI client.
DockerLatest stableDocker Engine + ComposeRequired for container management and local infrastructure orchestration.
Git>= 2.30LatestVersion 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, the docs package specifies >= 20.0.0 and the landing package is aligned with Node 22.20.0 (with .nvmrc set to 22).
  • 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 -v
    npm -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.mod and cohen/go.mod require 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.