OMS Commands

Full flag documentation for every OMS command is generated from the CLI itself and published at github.com/codesphere-cloud/oms/tree/main/docs. Run oms <command> --help for the same information locally. This page only lists which commands are relevant to an installation and why.

Command	Purpose
oms list packages	Browse installer packages available in the portal
oms download package	Download an installer package
oms init install-config	Generate config.yaml and prod.vault.yaml
oms init install-config --validate	Validate an install configuration without generating one
oms update install-config	Apply a targeted change to an existing config.yaml
oms template config	Render config.yaml with vault secrets substituted, for troubleshooting
oms install codesphere	Run the full installation
oms install codesphere infra / dependencies / platform	Run one installation phase at a time
oms smoketest codesphere	Run post-installation smoke tests
oms add-cluster-admin	Grant a user cluster-administrator access
oms beta bootstrap-local	Bootstrap a single-node evaluation environment
oms beta extend baseimage	Extend the default workspace base image
oms register	Register a portal API key
oms list api-keys	List portal API keys
oms version	Print the OMS version

See Install steps and profiles for the install steps and phases these commands drive.