Welcome to the comprehensive documentation for OpenFrame CLI - a modern, interactive command-line tool for managing OpenFrame Kubernetes clusters and development workflows.
New to OpenFrame CLI? Start here to get up and running quickly:
- Introduction - Overview of OpenFrame CLI and key concepts
- Prerequisites - System requirements and dependency installation
- Quick Start - Get OpenFrame running in 5 minutes
- First Steps - Explore key features and workflows
Resources for developers working on or with OpenFrame CLI:
- Development Overview - Developer documentation index
- Environment Setup - IDE configuration, tools, and development environment
- Local Development - Clone, build, and run OpenFrame CLI locally
- Architecture Overview - System design and component relationships
Technical reference documentation generated from source code analysis:
- Architecture Documentation - Comprehensive system architecture and component design
Visual documentation to understand system architecture and workflows:
- Architecture Diagrams - Mermaid diagrams showing system design, data flows, and component relationships
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.
- Check Prerequisites
- Follow Quick Start
- Explore First Steps
- Set up Development Environment
- Review Architecture Documentation
- Check Contributing Guidelines
- Review Prerequisites for system requirements
- Follow Bootstrap Guide
- Explore cluster management commands in First Steps
This documentation covers all major OpenFrame CLI capabilities:
- Complete Environment Bootstrapping: One-command setup with
openframe bootstrap - Cluster Management: Create, delete, and monitor K3D Kubernetes clusters
- Chart & Application Management: Helm charts and ArgoCD GitOps workflows
- Development Tools: Service intercepts, scaffolding, and local development workflows
- Multi-mode Deployment: OSS tenant, SaaS tenant, and SaaS shared configurations
- Project README - Main project overview and installation
- Contributing - How to contribute to OpenFrame CLI
- License - Project license information
Before using OpenFrame CLI, ensure your system meets these requirements:
| Resource | Minimum | Recommended |
|---|---|---|
| RAM | 24GB | 32GB |
| CPU Cores | 6 cores | 12 cores |
| Disk Space | 50GB free | 100GB free |
Required tools that must be installed:
- One-Command Bootstrap: Complete environment setup with single command
- Developer-Friendly: Interactive prompts, clear error messages, rich terminal UI
- GitOps Native: Built-in ArgoCD integration for modern deployment practices
- Local Development: Telepresence service intercepts for debugging
- Multi-Platform: Linux, macOS, and Windows (WSL2) support
- Open Source: Complete transparency and community-driven development
Need help or want to contribute?
- Primary Support: OpenMSP Slack
- Website: https://flamingo.run
- OpenFrame Platform: https://openframe.ai
Note: We don't monitor GitHub Issues for support. All community support and discussion happens in our Slack workspace.
This documentation is automatically generated and maintained by the OpenFrame development team. If you find errors or have suggestions for improvement, please reach out in the OpenMSP Slack community.
Documentation generated by OpenFrame Doc Orchestrator