CLI Commands Cheat Sheet

General

atmos

Start an interactive UI to select an Atmos command, component and stack. Press "Enter" to execute the command.

atmos help

Show help for all Atmos CLI commands

atmos docs

Open the Atmos documentation in a web browser

atmos version
atmos --version

Get the Atmos CLI version

atmos completion

Generate completion scripts for Bash, Zsh, Fish and PowerShell

Describe Commands

atmos describe affected

Generate a list of the affected Atmos components and stacks given two Git commits

atmos describe component

Describe the complete configuration for an Atmos component in an Atmos stack

atmos describe config

Show the final (deep-merged) CLI configuration of all atmos.yaml file(s)

atmos describe dependents

Show a list of Atmos components in Atmos stacks that depend on the provided Atmos component

atmos describe stacks

Show the fully deep-merged configuration for all Atmos stacks and the components in the stacks

atmos describe workflows

Show the configured Atmos workflows

Terraform Commands

atmos terraform

Execute terraform commands

atmos terraform clean

Delete 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 deploy

Execute terraform apply -auto-approve on an Atmos component in an Atmos stack

atmos terraform generate backend

Generate a Terraform backend config file for an Atmos terraform component in an Atmos stack

atmos terraform generate backends

Generate the Terraform backend config files for all Atmos terraform components in all stacks

atmos terraform generate varfile

Generate a varfile (.tfvar ) for an Atmos terraform component in an Atmos stack

atmos terraform generate varfiles

Generate the terraform varfiles (.tfvar) for all Atmos terraform components in all stacks

atmos terraform shell

Start 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 workspace

Calculate 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

Helmfile Commands

atmos helmfile

Execute helmfile commands

atmos helmfile generate varfile

Generate a varfile for a helmfile component in an Atmos stack

Validate Commands

atmos validate component

Validate an Atmos component in a stack using JSON Schema and OPA policies

atmos validate stacks

Validate all Atmos stack configurations

Core Commands

atmos vendor pull

Pull sources and mixins from remote repositories for Terraform and Helmfile components and other artifacts

atmos workflow

Perform sequential execution of atmos and shell commands defined as workflow steps

Integrations

atmos aws eks update-kubeconfig

Download kubeconfig from an EKS cluster and save it to a file

atmos atlantis generate repo-config

Generates repository configuration for Atlantis