Orchestr8 CLI Reference
The Orchestr8 CLI (o8) is the primary tool for managing your Kubernetes platform deployments across cloud providers.
Installation
# Install uv (if not already installed)
# macOS/Linux:
curl -LsSf https://astral.sh/uv/install.sh | sh
# Windows PowerShell:
# irm https://astral.sh/uv/install.ps1 | iex
# Install the Orchestr8 CLI
uv tool install orchestr8-platform
# Verify installation
o8 --version
Note: uv automatically handles Python installation and environment management, so no separate Python installation is required.
Command Structure
The CLI is organized into logical command groups:
Main Commands
Core platform management commands that work across all deployments.
| Command | Description |
|---|---|
setup | Initialize and deploy Orchestr8 platform |
status | Check platform health and connectivity |
teardown | Remove platform components and infrastructure |
validate | Check prerequisites and environment |
doctor | Comprehensive environment diagnostics |
Authentication & Configuration
Manage authentication and platform configuration.
| Command | Description |
|---|---|
auth | Configure GitHub repository access |
repos | Setup ArgoCD Helm repositories |
idp | Configure identity providers (GitHub, Google, Microsoft) |
GitOps Management
Direct ArgoCD application management commands.
| Command | Description |
|---|---|
sync | Sync ArgoCD applications |
apps | List all ArgoCD applications |
Module Management
Deploy and manage applications as modules.
| Command Group | Description |
|---|---|
module | Full module lifecycle management (6 commands) |
Infrastructure & Platform
Advanced cluster and infrastructure management.
| Command Group | Description |
|---|---|
bootstrap | Kubernetes cluster bootstrapping (4 commands) |
secrets | Cloud secrets management (9 commands) |
branch | Branch-based deployments (4 commands) |
Multi-Tenancy
Enterprise multi-tenant management capabilities.
| Command Group | Description |
|---|---|
tenant | Multi-tenant platform management (9 commands) |
Advanced Management
Platform component administration.
| Command Group | Description |
|---|---|
argocd | ArgoCD administration (3 commands) |
Prerequisites
Before using the Orchestr8 CLI, ensure you have the required tools installed. See the Installation Guide for complete setup instructions including tool requirements.
Getting Help
Get help for any command or command group:
# Main CLI help
o8 --help
# Command group help
o8 module --help
# Specific command help
o8 setup --help
Exit Codes
All Orchestr8 commands follow standard Unix exit code conventions:
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error |
| 2 | Configuration error |
| 3 | Authentication error |
| 4 | Resource not found |
| 5 | Permission denied |
Environment Variables
Common environment variables used across commands:
| Variable | Description | Default |
|---|---|---|
GITHUB_TOKEN | GitHub personal access token | None |
GOOGLE_CLOUD_PROJECT | GCP project ID | None |
AWS_REGION | AWS region | us-east-1 |
AZURE_SUBSCRIPTION_ID | Azure subscription ID | None |
Examples
Quick Start
# Deploy locally for development
o8 setup --provider local
# Deploy to GCP with infrastructure provisioning
o8 setup --provider gcp --provision-infrastructure --gcp-project-id my-project
# Check platform status
o8 status
# Deploy an application module
o8 module deploy ./my-app --environment production
Common Workflows
# Environment diagnostics
o8 doctor --verbose
# Configure GitHub authentication
o8 auth --github-org mycompany
# Manage secrets
o8 secrets create database-password --provider aws --data "password123"
# Multi-tenant deployment
o8 tenant init customer-a --modules langfuse,voicefuse
o8 tenant deploy customer-a --environment production
For detailed information about each command, see the specific command documentation in the sections below.