Prerequisites

Before installing HypLab, you need a few tools on your machine. This page tells you exactly what to install and where to get it.

Required software

Docker Desktop

Docker runs HypLab's database, cache, and services in isolated containers so you don't have to install them individually.

• Download: docker.com/products/docker-desktop
• Minimum version: Docker 20+ with Docker Compose v2
• Available for: macOS, Windows, Linux

After installing, verify it works:

docker --version
# Docker version 27.x.x or similar

docker compose version
# Docker Compose version v2.x.x

Node.js

Node.js runs the backend API and the frontend application.

• Download: nodejs.org (use the LTS version)
• Minimum version: Node.js 22.11.0+
• Includes: npm 10.9.0+ (installed automatically with Node.js)

After installing, verify it works:

node --version
# v22.11.0 or higher

npm --version
# 10.9.0 or higher

Git

Git is needed to download the HypLab source code.

• Download: git-scm.com/downloads
• Note: macOS and most Linux distributions include Git already.

git --version
# git version 2.x.x

Python (for AI agents)

Python runs the AI agents that power template generation, people generation, and persona creation.

• Download: python.org/downloads
• Minimum version: Python 3.11+

python3 --version
# Python 3.11.x or higher

Make (optional but recommended)

Make provides shortcut commands that simplify common tasks. It is pre-installed on macOS and most Linux distributions. On Windows, you can use it through WSL or Git Bash.

make --version
# GNU Make 3.81 or similar

Quick checklist

Run these commands to verify everything is ready:

docker --version        # Docker 20+
docker compose version  # Compose v2+
node --version          # Node.js 22.11.0+
npm --version           # npm 10.9.0+
git --version           # Git 2+
python3 --version       # Python 3.11+

If any command fails or shows a version lower than required, install or update that tool using the links above.

What you should see

When all prerequisites are met, every command above returns a version number without errors. You are now ready to install HypLab.

Next: Installation -- clone the repo and start the services.