OpenFrame CLI is a modern, interactive command-line tool for managing OpenFrame Kubernetes clusters and development workflows. It provides seamless cluster lifecycle management, chart installation with ArgoCD, and developer-friendly tools for service intercepts and scaffolding.

OpenFrame CLI is part of the broader OpenFrame ecosystem - an AI-powered MSP platform that replaces expensive proprietary software with open-source alternatives enhanced by intelligent automation. The CLI serves as the entry point for developers and operators to bootstrap, manage, and develop on OpenFrame environments.

• One-command setup: Bootstrap entire OpenFrame environments with openframe bootstrap
• Multi-mode deployment: Support for OSS tenant, SaaS tenant, and SaaS shared modes
• Automated cluster creation: Creates K3D clusters with all necessary components
• ArgoCD integration: Automatic chart installation and application management

• Lifecycle operations: Create, delete, list, and monitor Kubernetes clusters
• K3D integration: Lightweight Kubernetes for development and testing
• Status monitoring: Real-time cluster health and resource monitoring
• Easy cleanup: Remove clusters and associated resources with simple commands

• Helm chart installation: Streamlined chart deployment with dependency management
• ArgoCD applications: GitOps-based application lifecycle management
• App-of-apps pattern: Hierarchical application management for complex deployments
• Synchronization monitoring: Track deployment progress with detailed logging

• Service intercepts: Local development with Telepresence integration
• Scaffolding: Generate boilerplate code and configurations
• Live debugging: Debug services running in Kubernetes from your local environment
• Hot reload: Rapid development cycles with instant feedback

graph TB
    subgraph "CLI Commands"
        Bootstrap[openframe bootstrap]
        Cluster[openframe cluster]
        Chart[openframe chart]
        Dev[openframe dev]
    end
    
    subgraph "Core Services"
        ClusterSvc[Cluster Management]
        ChartSvc[Chart Installation]
        DevSvc[Development Tools]
    end
    
    subgraph "External Tools"
        K3D[K3D Clusters]
        Helm[Helm Charts]
        ArgoCD[ArgoCD Apps]
        Telepresence[Service Intercepts]
    end
    
    subgraph "Target Environment"
        K8s[Kubernetes]
        Apps[Applications]
        Services[Microservices]
    end
    
    Bootstrap --> ClusterSvc
    Bootstrap --> ChartSvc
    Cluster --> ClusterSvc
    Chart --> ChartSvc
    Dev --> DevSvc
    
    ClusterSvc --> K3D
    ChartSvc --> Helm
    ChartSvc --> ArgoCD
    DevSvc --> Telepresence
    
    K3D --> K8s
    Helm --> Apps
    ArgoCD --> Apps
    Telepresence --> Services

Get OpenFrame CLI up and running in 5 minutes!

Before installation, ensure you have:

• Docker 20.10+
• kubectl 1.25+
• Helm 3.10+
• K3D 5.0+

Choose your platform and install OpenFrame CLI:

curl -fsSL https://github.com/flamingo-stack/openframe-cli/releases/latest/download/openframe-cli_linux_amd64.tar.gz | tar -xz
sudo mv openframe /usr/local/bin/
chmod +x /usr/local/bin/openframe

curl -fsSL https://github.com/flamingo-stack/openframe-cli/releases/latest/download/openframe-cli_darwin_arm64.tar.gz | tar -xz
sudo mv openframe /usr/local/bin/
chmod +x /usr/local/bin/openframe

1. Download: https://github.com/flamingo-stack/openframe-cli/releases/latest/download/openframe-cli_windows_amd64.zip
2. Extract and move openframe.exe to a directory in your PATH
3. Open WSL2 terminal and verify access

Create a complete OpenFrame environment with a single command:

# Verify installation
openframe --version

# Bootstrap complete environment
openframe bootstrap

# Check cluster status
openframe cluster status

The bootstrap process creates:

• K3D Kubernetes cluster
• ArgoCD for GitOps deployment
• Traefik ingress controller
• Core monitoring and logging components

OpenFrame CLI integrates with industry-standard tools:

• Kubernetes: Container orchestration with K3D for development
• ArgoCD: GitOps continuous deployment
• Helm: Package management for Kubernetes
• Telepresence: Local development with remote services
• Docker: Container runtime and image management
• Cobra: Modern CLI framework with rich help and completion

📚 See the Documentation for comprehensive guides including:

• Getting Started: Prerequisites, installation, and first steps
• Development: Local setup, architecture, and contribution guidelines
• Reference: Technical documentation, API specs, and configuration
• CLI Tools: Links to external repositories and tools

OpenFrame is built by the community for the community:

• OpenMSP Slack: Join the community - Primary support channel
• Website: https://flamingo.run
• OpenFrame Platform: https://openframe.ai

Note: We don't use GitHub Issues or Discussions. All support and community interaction happens in the OpenMSP Slack community.

This project is licensed under the Flamingo AI Unified License v1.0 - see the LICENSE.md file for details.