Skip to main content

CLI Commands Cheat Sheet

CommandDescription
atmos helpShow help for all Atmos CLI commands
atmos versionGet the Atmos CLI version
atmos completionGenerate completion scripts for Bash, Zsh, Fish and PowerShell
atmos describe affectedGenerate a list of the affected Atmos components and stacks given two Git commits
atmos describe componentDescribe the complete configuration for an Atmos component in an Atmos stack
atmos describe configShow the final (deep-merged) CLI configuration of all atmos.yaml file(s)
atmos describe dependentsShow a list of Atmos components in Atmos stacks that depend on the provided Atmos component
atmos describe stacksShow the fully deep-merged configuration for all Atmos stacks and the components in the stacks
atmos terraformExecute terraform commands
atmos terraform cleanDelete the .terraform folder, the folder that TF_DATA_DIR ENV var points to, .terraform.lock.hcl file, varfile and planfile for a component in a stack
atmos terraform deployExecute terraform apply -auto-approve on an Atmos component in an Atmos stack
atmos terraform generate backendGenerate a Terraform backend config file for an Atmos terraform component in an Atmos stack
atmos terraform generate backendsGenerate the Terraform backend config files for all Atmos terraform components in all stacks
atmos terraform generate varfileGenerate a varfile (.tfvar ) for an Atmos terraform component in an Atmos stack
atmos terraform generate varfilesGenerate the terraform varfiles (.tfvar) for all Atmos terraform components in all stacks
atmos terraform shellStart a new SHELL configured with the environment for an Atmos component in a stack to allow executing all native terraform commands inside the shell without using any atmos-specific arguments and flags
atmos terraform workspaceCalculate the Terraform workspace for an Atmos component (from the context variables and stack config), then run terraform init -reconfigure, then select the workspace by executing the terraform workspace select command
atmos helmfileExecute helmfile commands
atmos helmfile generate varfileGenerate a varfile for a helmfile component in an Atmos stack
atmos validate componentValidate an Atmos component in a stack using JSON Schema and OPA policies
atmos validate stacksValidate all Atmos stack configurations
atmos vendor pullPull sources and mixins from remote repositories for a Terraform or Helmfile component
atmos workflowPerform sequential execution of atmos and shell commands defined as workflow steps
atmos aws eks update-kubeconfigDownload kubeconfig from an EKS cluster and save it to a file
atmos atlantis generate repo-configGenerates repository configuration for Atlantis