Knowledge Hub
Comprehensive guides and references for the OpenFrame platform
OpenFrame Gen1 is Here Β· Our AI platform for autonomous IT is out of beta.
Comprehensive guides and references for the OpenFrame platform
Welcome to the official documentation for OpenFrame CLI, the command-line tool that bootstraps and manages OpenFrame Kubernetes environments.
OpenFrame is the unified platform from Flamingo that integrates multiple MSP tools into a single AI-driven interface, automating IT support operations across the stack.
New to OpenFrame CLI? Start here:
| Guide | Description |
|---|---|
| Introduction | What is OpenFrame CLI and what can it do? |
| Prerequisites | System requirements, required tools, and environment setup |
| Quick Start | Download, install, and run your first openframe bootstrap in 5 minutes |
| First Steps | Explore key features and commands after your first installation |
Documentation for contributors and developers working on the CLI:
| Guide | Description |
|---|---|
| Development Overview | Repository structure, tech stack, and navigation index |
| Environment Setup | Go toolchain, IDE configuration, and linting tools |
| Local Development | Clone, build, run, debug, and iterate on the CLI |
| Architecture Overview | High-level design, component breakdown, and data flows |
| Security Guidelines | Secret handling, input validation, and security patterns |
| Testing Guide | Unit tests, integration tests, mocks, and coverage targets |
| Contributing Guidelines | Code style, branch naming, commit messages, and PR process |
| Release Signing | Binary signing for macOS, Windows, and cosign verification |
Technical reference documentation generated from source code analysis:
| Document | Description |
|---|---|
| Architecture Reference | Full component reference β commands, services, providers, shared infrastructure, CLI command reference, and dependency table |
Visual documentation for the OpenFrame CLI architecture. View Mermaid (.mmd) diagrams using any Mermaid-compatible renderer (VS Code with the Mermaid extension, GitHub, or the Mermaid Live Editor):
| Diagram | Description |
|---|---|
| High-Level System Design | Overview of CLI entry point, command layer, service layer, providers, and external tools |
| Dependency Flowchart | How commands wire into services, providers, and shared infrastructure |
| Bootstrap Sequence Diagram | Full sequence of openframe bootstrap from user invocation to platform ready |
| App Install/Upgrade Data Flow | Sequence diagram for openframe app install and context selection |
The OpenFrame platform configuration β Helm charts and values β lives in a separate repository maintained independently:
Note: The
openframe-oss-tenantrepository is not located in a subdirectory of this CLI repository. Always reference the external repository for platform chart installation and usage.
| Resource | Link |
|---|---|
| Project README | ../README.md |
| Contributing Guide | ../CONTRIBUTING.md |
| Releases | https://github.com/flamingo-stack/openframe-cli/releases |
| OpenMSP Slack | https://www.openmsp.ai/ |
| OpenFrame Platform | https://openframe.ai |
| Flamingo | https://flamingo.run |
All questions, feature discussions, and bug reports are handled in the OpenMSP Slack community β there are no GitHub Issues or Discussions for this project.
Documentation generated by 𦩠Flamingo AI Technical Writer