Skip to main content

Atmos CLI

Atmos is a CLI for provisioning infrastructure with Terraform, Helmfile, Packer, and more, and for running workflows and custom commands. Run atmos without arguments to open an interactive UI for selecting a command, stack, and component. When no stack manifests are available, or input or output is not an interactive terminal, Atmos displays help instead, including configured custom commands. You can use Atmos for workflows and custom commands without configuring stacks.

Usage​

Run atmos in an interactive terminal to open the stack picker in a project with stacks:

atmos

To display help regardless of whether stacks are configured, use:

atmos --help
atmos help

To see usage and options for a specific command, append --help:

atmos workflow --help
atmos terraform plan --help
tip

To quickly check the Atmos version, use atmos --version or atmos version. See the version command for more details.

Interactive Picker​

  • Use the left/right arrow keys to move between the Commands, Stacks, and Components views.
  • Use the up/down arrow keys or mouse wheel to select an item.
  • Press / to filter commands, stacks, or components.
  • Press Tab to switch between browsing components in a stack and stacks containing a component.
  • Press Enter to execute the selected command, or Esc / Ctrl+C to quit.

Try the quickstart and run atmos to explore the picker:

atmos (interactive)
00:00.0 / 00:00.0

Featured Examples​

Explore ways to provision infrastructure and automate tasks with Atmos, or browse the full list of examples.

atmos quick start simple

Quick Start (Simple)

Minimal Atmos setup with a single component and three environments — no cloud credentials or access required.

atmos quick start advanced

Quick Start (Advanced)

A small AWS application stack end to end — backend provisioning, secrets, identities, and Terraform against a local AWS emulator.

atmos sops secrets lifecycle

SOPS Secrets

Declare, encrypt, and read secrets with a SOPS backend (age encryption) — no cloud credentials required.