Knowledge Hub

Quick Start

Install openframe and bootstrap a local OpenFrame environment.

TL;DR

# Install (Linux/macOS example below)
curl -fsSL https://github.com/flamingo-stack/openframe-cli/releases/latest/download/openframe-cli_linux_amd64.tar.gz | tar -xz
sudo mv openframe /usr/local/bin/

openframe --version
openframe bootstrap
openframe cluster status

Step 1: Install the CLI

Option A: Pre-built binary (recommended)

Download the release for your platform, then move it onto your PATH:

# Linux amd64  (swap linux_amd64 for linux_arm64, darwin_amd64, or darwin_arm64)
curl -fsSL https://github.com/flamingo-stack/openframe-cli/releases/latest/download/openframe-cli_linux_amd64.tar.gz | tar -xz
sudo mv openframe /usr/local/bin/

On Windows, download openframe-cli_windows_amd64.zip from the releases page, extract it, and put openframe.exe on your PATH. The CLI re-execs itself inside WSL2, so run openframe ... normally.

Once installed, the CLI can update itself — see Step 5.

Option B: Build from source

Requires Go 1.24+:

git clone https://github.com/flamingo-stack/openframe-cli.git
cd openframe-cli
go build -o openframe .
sudo mv openframe /usr/local/bin/

Step 2: Verify Installation

openframe --version
openframe --help

Step 3: Bootstrap Your Environment

openframe bootstrap checks prerequisites, installs any missing tools, creates a k3d cluster, and installs the OpenFrame platform via the ArgoCD app-of-apps:

openframe bootstrap

The interactive wizard prompts for configuration options. For CI or scripting, run non-interactively — --non-interactive reuses the existing openframe-helm-values.yaml:

openframe bootstrap --non-interactive

Step 4: Verify Your Environment

Check cluster health:

openframe cluster status

Check the platform deployment:

openframe app status

Get the ArgoCD URL, admin credentials, and port-forward command:

openframe app access

This prints the kubectl port-forward svc/argocd-server command and the admin login. Run it, then open the printed URL.

Step 5: Keep the CLI Up to Date

openframe update check      # see if a newer release is available
openframe update            # download a verified release and replace the binary

See First Steps for rollback and auto-update.

Troubleshooting

Docker not running

docker ps        # must succeed
docker info

Start Docker Desktop (macOS/Windows) or sudo systemctl restart docker (Linux).

kubectl can't connect

kubectl config current-context   # should be k3d-<cluster-name>
kubectl config get-contexts

ArgoCD not reachable

openframe app access             # re-print URL, credentials, and port-forward
kubectl get pods -n argocd

Next Steps

• First Steps — Core commands and workflows

Need help? OpenMSP Slack