openframe is an interactive command-line tool for standing up and managing OpenFrame Kubernetes environments. It provisions local k3d clusters, deploys the OpenFrame platform via an ArgoCD app-of-apps GitOps workflow, and keeps itself up to date.
This repository (flamingo-stack/openframe-cli) is the CLI. The platform and application manifests it deploys live in flamingo-stack/openframe-oss-tenant.
- Introduction — Overview and key concepts
- Prerequisites — System requirements and dependencies
- Quick Start — Install and bootstrap in a few minutes
- First Steps — Core commands and workflows
- Cloud Clusters — Provision EKS/GKE clusters with Terraform (reference)
- GKE Workflow — Step-by-step: from zero to a running GKE cluster
- Terminal Output — Live dashboards, sequential/CI mode,
--plain/--silent/--verbose, color and glyph controls, GitHub Actions integration
openframe bootstrap— Create a cluster and install the platform in one stepopenframe cluster {create,delete,list,status,cleanup}— Manage k3d and cloud (EKS/GKE) clustersopenframe app {install,upgrade,status,access,uninstall}— Manage the OpenFrame app-of-apps deployment (statusalso has--watchand--interactivelive views)openframe prerequisites {check,install}— Check and install required toolsopenframe update(check,rollback,update <version>) — Self-update the CLIopenframe completion— Generate shell completion scripts
A full local platform is demanding. Recommended host:
| Resource | Recommended |
|---|---|
| RAM | 24 GB |
| CPU | 6 cores |
| Disk | 50 GB free |
Docker is the only tool you install and run yourself. The CLI auto-installs pinned, verified copies of kubectl, k3d, and helm into ~/.openframe/bin. mkcert is used to issue a locally-trusted certificate for the HTTPS ingress. See Prerequisites.
- Slack: OpenMSP community (primary support channel)
- Website: https://flamingo.run
- Platform: https://openframe.ai
We don't monitor GitHub Issues for support — use Slack.
See LICENSE.md.