CLI Commands

Purpose: For platform engineers, provides the maintained opencenter command inventory derived from the live Cobra command tree.

Refresh the generated inventory from the openCenter-cli repo with:

go run -tags tools ./cmd/docs

Global Flags

Flag	Description
--config-dir <path>	Configuration directory override
--dry-run	Print planned actions without executing them
--log-level <level>	Set log level: debug, info, warn, error
--output <format>	Output format: text, json, yaml
--quiet	Suppress non-essential output
--yes	Skip confirmation prompts
-h, --help	Show command help
-v, --version	Show version information

Root Commands

Command	Purpose
opencenter cluster	Cluster lifecycle, validation, generation, drift, services, backup, and key management
opencenter completion	Shell completion scripts for bash, fish, powershell, and zsh
opencenter settings	CLI defaults, local IDE configuration, and cluster-defaults
opencenter plugins	External plugin discovery
opencenter secrets	Secret encryption, sync, validation, and key operations
opencenter shell-init	Session-scoped shell integration for active-cluster selection
opencenter version	Version and build metadata
opencenter <external-plugin>	Dynamically discovered plugin entrypoints such as rmpk

Cluster Commands

Lifecycle

Command	Description
opencenter cluster init <name> --org <org> [--type openstack|vmware|kind|baremetal]	Initialize a new cluster configuration
opencenter cluster configure <org/name> --guided	Interactive guided configuration
opencenter cluster validate <org/name> [--manifests] [--output json]	Validate cluster configuration
opencenter cluster generate <org/name> [--render-only]	Generate GitOps manifests and infrastructure code
opencenter cluster deploy <org/name> [--restart]	Deploy the cluster (provisions infra + bootstraps K8s)
opencenter cluster destroy <org/name> [--force] [--remove-files]	Destroy cluster and optionally remove files

Cluster Management

Command	Description
opencenter cluster list	List all clusters
opencenter cluster use <org/name>	Set active cluster
opencenter cluster active	Show current active cluster
opencenter cluster status <org/name> [--paths] [--sync] [--output json]	Show cluster status
opencenter cluster describe <org/name>	Detailed cluster information
opencenter cluster doctor <org/name>	Diagnose cluster health issues
opencenter cluster env	Export cluster environment variables for shell

Configuration

Command	Description
opencenter cluster set <org/name> <path=value>	Set a configuration value
opencenter cluster edit <org/name>	Open cluster config in editor
opencenter cluster normalize <org/name>	Canonicalize configuration (resolve aliases, apply defaults)
opencenter cluster export <org/name> [--output-file <file>]	Export effective configuration

Service Management

Command	Description
opencenter cluster service enable <svc> --cluster <org/name> [--managed] [--param key=val]	Enable a platform service
opencenter cluster service disable <svc> --cluster <org/name>	Disable a platform service
opencenter cluster service status --cluster <org/name>	Show service statuses
opencenter cluster service options <svc>	Show configurable options for a service

Drift Detection

Command	Description
opencenter cluster drift detect <org/name>	Detect configuration drift
opencenter cluster drift reconcile <org/name>	Reconcile detected drift
opencenter cluster drift schedule <org/name>	Schedule periodic drift checks

Backup & Restore

Command	Description
opencenter cluster backup create <org/name>	Create cluster backup
opencenter cluster backup list <org/name>	List available backups
opencenter cluster backup restore <backup-id>	Restore from backup
opencenter cluster backup delete <backup-id>	Delete a backup
opencenter cluster backup schedule <org/name>	Schedule periodic backups

Import

Command	Description
opencenter cluster import scan --repo-path <path>	Scan existing repo for import
opencenter cluster import report	Show import analysis report
opencenter cluster import apply	Apply import changes

Operations

Command	Description
opencenter cluster lock <org/name>	Lock cluster to prevent concurrent operations
opencenter cluster unlock <org/name>	Unlock cluster
opencenter cluster migrate-layout --org <org>	Migrate cluster files to current layout

Settings Commands

Command	Description
opencenter settings view	Display current settings
opencenter settings set <key> <value>	Set a settings value
opencenter settings get <key>	Get a settings value
opencenter settings path	Show settings file path
opencenter settings edit	Open settings in editor
opencenter settings reset	Reset to defaults
opencenter settings explain [cluster-defaults]	Explain settings and their effects
opencenter settings ide	Configure IDE integration

Secrets Commands

Core Operations

Command	Description
opencenter secrets encrypt	Encrypt secrets
opencenter secrets decrypt	Decrypt secrets
opencenter secrets status	Show encryption status
opencenter secrets sync <org/name> [--all --org <org>]	Sync secrets to cluster
opencenter secrets validate <org/name>	Validate secret integrity
opencenter secrets login	Authenticate to secrets backend
opencenter secrets list	List secrets
opencenter secrets describe <name>	Show secret details
opencenter secrets get <name>	Get a secret value
opencenter secrets set <name>	Set a secret value
opencenter secrets delete <name>	Delete a secret

Key Management

Command	Description
opencenter secrets keys generate	Generate new age keypair
opencenter secrets keys list	List available keys
opencenter secrets keys rotate <org/name> --type sops	Rotate encryption keys
opencenter secrets keys check	Check key health
opencenter secrets keys backup	Backup keys
opencenter secrets keys validate	Validate key integrity
opencenter secrets keys revoke --user <email>	Revoke a user's key access

Completion Commands

Command	Description
opencenter completion bash	Generate bash completions
opencenter completion zsh	Generate zsh completions
opencenter completion fish	Generate fish completions
opencenter completion powershell	Generate PowerShell completions

Exit Codes

Code	Meaning
0	Success
1	General error (validation, provider, network, unclassified)
3	Config not found (cluster doesn't exist)

Use --output json for structured error details in automation.

GA Notes

• Canonical infrastructure provider names are openstack, vmware, kind, and baremetal.
• vsphere remains accepted as a compatibility alias for existing configuration files, but documentation now uses vmware.
• AWS is NOT a GA infrastructure provider. AWS service integrations (Route53, S3) remain available for platform services.