OpenFrame Documentation
Deployment guides, the CLI reference, architecture and admin guides for OpenFrame
Flamingo Raises $4.5M Seed Round · Led by Vertex Ventures, bringing total funding to $6.7M to build the open, AI-native layer for IT and security.
Deployment guides, the CLI reference, architecture and admin guides for OpenFrame
OpenFrame CLI (openframe) is the Go-based command-line tool that bootstraps and manages the lifecycle of the OpenFrame platform by Flamingo. It provisions Kubernetes clusters — locally via k3d, or in the cloud via GKE/EKS through Terraform — and then deploys the OpenFrame platform onto those clusters using ArgoCD's app-of-apps pattern.
In a single command, openframe bootstrap takes you from nothing to a running OpenFrame platform: it creates a local k3d cluster and installs ArgoCD plus the app-of-apps in one staged flow. Beyond that one-shot path, the CLI also exposes granular commands for cluster lifecycle management, platform installation/upgrade, prerequisite checking, status monitoring, and self-update — with both interactive wizards for humans and non-interactive flags for CI/automation.
The OpenFrame platform's application code itself — the services the CLI deploys — lives in a separate repository, flamingo-stack/openframe-oss-tenant, which this CLI clones at install/upgrade time and deploys via its app-of-apps Helm chart. This repository (flamingo-stack/openframe-cli) contains only the CLI itself.
openframe bootstrap chains cluster creation and platform installation into a single staged flow with progress tracking, so a local OpenFrame environment is one command away.openframe cluster command surface.--ref.openframe prerequisites check and install detect and (on macOS/Linux) auto-install the tools each cluster backend needs — Docker, k3d, Helm, Terraform, gcloud, the AWS CLI — with documentation links printed instead on Windows.openframe app status reports cluster reachability and ArgoCD application sync/health, with --watch for a live-refreshing view and --interactive for a k9s-style terminal UI (navigate applications, inspect details, trigger syncs).openframe app uninstall and openframe cluster delete remove the platform or the cluster in a deliberate order (Applications, then Helm releases, then finalizers, then optional namespace), asking for confirmation unless --yes/--force is given.--output json|yaml for scripting, and --non-interactive skips every prompt for CI pipelines.OpenFrame CLI is built for:
flowchart TB
subgraph CmdLayer["CLI commands"]
Bootstrap[openframe bootstrap]
Cluster[openframe cluster]
App[openframe app]
Prereq[openframe prerequisites]
Update[openframe update]
end
subgraph Providers["Cluster providers"]
K3d[k3d local cluster]
EKS[EKS via Terraform]
GKE[GKE via Terraform]
end
subgraph PlatformLayer["Platform deployment"]
ArgoCD[ArgoCD]
AppOfApps["app-of-apps chart"]
end
subgraph External["External systems"]
Docker[("Docker")]
K8sAPI[("Kubernetes API")]
CloudAPI[("GCP / AWS APIs")]
GitHubReleases[("GitHub Releases")]
OSSTenant["flamingo-stack/openframe-oss-tenant"]
end
Bootstrap --> Cluster
Bootstrap --> App
Cluster --> K3d
Cluster --> EKS
Cluster --> GKE
App --> ArgoCD
ArgoCD --> AppOfApps
AppOfApps --> OSSTenant
K3d --> Docker
EKS --> CloudAPI
GKE --> CloudAPI
ArgoCD --> K8sAPI
Prereq --> Docker
Update --> GitHubReleases
This repository publishes a single Go module, github.com/flamingo-stack/openframe-cli, distributed as pre-built binaries via GitHub Releases and installable with go install. According to the organization's dependency graph, it has no recorded upstream dependencies on other internally-published artifacts and no internal repository depends on it — it is a standalone, user-facing CLI binary, not a library consumed by other services.
| Resource | Minimum | Recommended |
|---|---|---|
| RAM | 24 GB | 32 GB |
| CPU Cores | 6 | 12 |
| Disk Space | 50 GB | 100 GB |
Windows users download the AMD64 build directly from the releases page:
https://github.com/flamingo-stack/openframe-cli/releases/latest/download/openframe-cli_windows_amd64.zip
Run the installer the same way as on other operating systems. As noted above, the native Windows build re-executes itself inside WSL2 before any cluster command runs.
For architecture details, see the Architecture overview, the Ecosystem graph, and the architecture diagrams. For contributing to this CLI, see the Development docs, including environment setup, local development, architecture, testing, contributing guidelines, and security.
This project does not use GitHub Issues or GitHub Discussions. Community support and discussion happen on the OpenMSP Slack community.
This repository is licensed under The Flamingo AI Unified License v1.1 (see LICENSE.md), copyright Flamingo AI, Inc. The license governs the Flamingo-authored source code in this repository; upstream components bundled elsewhere in the OpenFrame platform remain under their own original licenses as noted in that file's appendix. The Flamingo AI Unified License v1.1 does not govern the hosted OpenFrame service, OpenMSP, or the Flamingo website, which are covered separately by Flamingo AI's Terms of Service.