Project Documentation
OpenFrame Documentation
Deployment guides, the CLI reference, architecture and admin guides for OpenFrame
Data from GitHub ·Last updated: November 15, 2026
OpenFrame CLIREADME
Project Documentation
Welcome to the documentation for OpenFrame CLI.
OpenFrame CLI (openframe) is the Go-based command-line tool that bootstraps and manages the lifecycle of the OpenFrame platform by Flamingo.
📚 Table of Contents
Getting Started
- First Steps - What to do right after installing the OpenFrame CLI (
openframe): the first commands to run and the configuration you'll typically touch - Introduction - What OpenFrame CLI is and how it bootstraps and manages the OpenFrame platform
- Prerequisites - What you need before installing and running the OpenFrame CLI
- Quick Start - Fast path to getting OpenFrame CLI up and running
- How to check the status of your OpenFrame cluster and apps - Confirming whether the cluster is reachable and apps are healthy
- How to create a new Kubernetes cluster with OpenFrame CLI - Creating a new cluster using the
openframecommand - How to install the OpenFrame platform onto a cluster - Installing ArgoCD plus the app-of-apps onto an existing Kubernetes cluster
- How to uninstall OpenFrame and delete a cluster - Tearing down an OpenFrame deployment and its cluster
- How to upgrade OpenFrame CLI and its installed apps - Updating the
openframetool itself and upgrading the installed platform apps
Development
- Development - Entry point for anyone working on the OpenFrame CLI source code
- Architecture Overview - How OpenFrame CLI provisions Kubernetes clusters and deploys the OpenFrame platform
- Contributing Guidelines - How to propose changes to the OpenFrame CLI
- Security - How the CLI handles authentication, secrets, and input validation
- Local Development - Cloning, building, running, and debugging
openframe-clilocally (including with k3d) - Environment Setup - Setting up a local development environment for the OpenFrame CLI
- Testing - Testing approach for the Go service, which has no downstream consumers or upstream internal dependencies recorded in the org
Reference
Reference docs are in ./reference/architecture/:
- Ecosystem: OpenFrame CLI - How OpenFrame CLI fits the wider system as a service (bash, go)
- openframe-cli Module Documentation - Overview of how OpenFrame CLI bootstraps and manages the OpenFrame platform lifecycle
Diagrams
Visual documentation - View Mermaid diagrams in: ./diagrams/architecture/
- Diagrams Overview - Index of the architecture diagrams
./diagrams/architecture/architecture-diagram.mmd- High-level architecture diagram./diagrams/architecture/bootstrap-sequence.mmd- Sequence diagram of the bootstrap flow./diagrams/architecture/component-relationships.mmd- Diagram of relationships between components
CLI Tools
The OpenFrame Main code Repository is maintained in a separate repository:
- Repository: flamingo-stack/openframe-oss-tenant
- Documentation: CLI Documentation
Note: CLI tools are NOT located in this repository. Always refer to the external repository for installation and usage.
Other documentation
Documentation coming soon.
📖 Quick Links
- Project README - Main project README
- Contributing - How to contribute
- License - License information
Documentation generated by 🦩 Flamingo Code Documentation
Frequently Asked Questions
/knowledge-base/openframe-cli
Still deciding?
Ask Mingo answers from our docs and customer stories.
Ask Mingo Ctrl K
Loading questions