Knowledge Hub
Comprehensive guides and references for the OpenFrame platform
OpenFrame Gen1 is Here · Our AI platform for autonomous IT is out of beta.
Comprehensive guides and references for the OpenFrame platform
Before installing and using the OpenFrame CLI, ensure your environment meets the following requirements. The CLI can automatically check and install most prerequisites on macOS and Linux — on Windows, you will be guided to the relevant documentation.
| Resource | Minimum | Recommended |
|---|---|---|
| RAM | 24 GB | 32 GB |
| CPU Cores | 6 cores | 12 cores |
| Disk Space | 50 GB free | 100 GB free |
| Operating System | macOS, Linux, Windows (WSL2) | macOS or Linux |
Windows users: The OpenFrame CLI runs natively on Windows but automatically forwards all operations into WSL2 (Windows Subsystem for Linux). You must have WSL2 installed and a Linux distro configured. The CLI will auto-install itself inside WSL when first run.
| Tool | Minimum Version | Purpose | Auto-Installed? |
|---|---|---|---|
| Docker | 24.x or newer | Container runtime for K3D clusters | ✅ macOS/Linux |
| k3d | 5.x or newer | Lightweight K3D cluster manager | ✅ macOS/Linux |
| Helm | 3.x or newer | Kubernetes package manager | ✅ macOS/Linux |
| kubectl | 1.28+ | Kubernetes CLI (optional — CLI uses client-go directly) | ❌ Manual |
| WSL2 (Windows only) | Windows 10/11 | Linux environment on Windows | ❌ Manual |
Note: Docker, k3d, and Helm can be installed automatically by running
openframe prerequisites install. On Windows, the CLI will display documentation links for each missing tool.
docker group or have sudo accesswsl --install in PowerShell as Administratorwsl --install -d Ubuntu| Requirement | Details |
|---|---|
| GitHub Access | Required for downloading the openframe-oss-tenant chart and for self-updates |
| GitHub Token (optional) | Set OPENFRAME_GITHUB_TOKEN or GITHUB_TOKEN to avoid rate limiting |
| Internet Access | Required for downloading charts, container images, and updates |
The following environment variables are recognized by the CLI:
| Variable | Required | Description |
|---|---|---|
OPENFRAME_GITHUB_TOKEN |
Optional | GitHub personal access token (avoids API rate limits) |
GITHUB_TOKEN |
Optional | Standard GitHub token (also accepted) |
OPENFRAME_WSL_DISTRO |
Windows only | Target WSL distro name (default: WSL default distro) |
OPENFRAME_NO_WSL_FORWARD |
Windows only | Disable WSL forwarding (unsupported; use at your own risk) |
OPENFRAME_UPDATE_INSECURE_SKIP_VERIFY |
Emergency only | Skip cosign signature verification during updates |
KUBECONFIG |
Optional | Path to kubeconfig file (default: ~/.kube/config) |
Run these commands to verify your environment is ready before installing OpenFrame CLI:
docker --version
docker ps
Expected output: Docker version and an empty container list (confirms Docker is running).
k3d version
Expected output: k3d version vX.Y.Z
helm version
Expected output: version.BuildInfo{Version:"vX.Y.Z", ...}
# macOS
sysctl -n hw.memsize | awk '{print $1/1024/1024/1024 " GB"}'
# Linux
free -h
Ensure at least 24 GB RAM is available.
df -h .
Ensure at least 50 GB free on the relevant partition.
openframe prerequisites check
This is the most comprehensive check — the CLI will display exactly what is missing and how to fix it.
Step 1: Enable WSL2
Open PowerShell as Administrator and run:
wsl --install
Step 2: Install Ubuntu distro
wsl --install -d Ubuntu
Step 3: Install Docker Desktop
Download and install Docker Desktop for Windows. In Docker Desktop settings, enable:
Step 4: Set WSL2 as default (if needed)
wsl --set-default-version 2
wsl --set-default Ubuntu
Step 5: Download the Windows CLI binary
Download from: https://github.com/flamingo-stack/openframe-cli/releases/latest/download/openframe-cli_windows_amd64.zip
Extract and run the .exe — the CLI will automatically forward into WSL2.