OpenFrame CLI Documentation
Welcome to the documentation for OpenFrame CLI — the command-line tool for provisioning Kubernetes clusters (local k3d, or cloud GKE/EKS via Terraform) and deploying the OpenFrame platform onto them via ArgoCD's app-of-apps pattern.
📚 Table of Contents
Getting Started
- Introduction — What OpenFrame CLI is, key features, and who it's for
- Prerequisites — Required tools, hardware requirements, and environment variables
- Quick Start — From zero to a running local OpenFrame platform in ~5 minutes
- First Steps — Day-to-day commands after your first bootstrap
- GKE Workflow — Step-by-step walkthrough for provisioning a GKE cluster
- Cloud Clusters (EKS / GKE) — Reference for cloud cluster flags, state model, and troubleshooting
Development
- Development Overview — Where to start, project at a glance
- Environment Setup — Toolchain and editor setup
- Local Development — Cloning, building, running, and debugging
- Architecture — Core components, data flow, and key design decisions
- Security — Secure-by-default patterns, secret handling, and code review checklist
- Testing — Test structure, running tests, and coverage expectations
- Contributing Guidelines — Code style, branching, commits, and PR process
- Releasing — Semantic-release flow and release invariants
- Release Signing — macOS/Windows binary signing and verification
Reference
Technical reference documentation generated from the codebase:
- OpenFrame CLI Overview — Architecture, core components, dependency diagram, data flow, and CLI command reference
- Ecosystem — Published artifacts, upstream/downstream dependency graph
Diagrams
Visual documentation — Mermaid diagrams available in ./diagrams/architecture/:
architecture-diagram.mmd — High-level CLI layer, domain services, and provider architecturedependency-diagram.mmd — Component dependency graph across cmd/ and internal/bootstrap-sequence.mmd — Sequence diagram of the openframe bootstrap flowapp-status-aggregation.mmd — Sequence diagram of openframe app status aggregation logic
See also the diagrams README for context on each diagram.
CLI Tools
The OpenFrame platform that this CLI deploys is maintained in a separate repository:
Note: The OpenFrame platform source code is NOT located in this repository. This repository contains only the CLI that provisions clusters and installs that platform. Always refer to the external repository for platform-specific documentation.
📖 Quick Links
Community
There are no GitHub Issues or Discussions for this project. All discussions, questions, and support happen in the OpenMSP Slack community:
Documentation generated by 🦩 Flamingo Code Documentation