Skip to main content

Atmos CLI

Atmos is a CLI for provisioning infrastructure with Terraform, Helmfile, Packer, and more, using stack-based configuration. Run it with a subcommand for scripting and automation, or with no arguments at all to launch an interactive UI for running Atmos commands against any component or stack. Press Enter to execute the command for the selected stack and component

Usage​

Just run the atmos command in your terminal to start the interactive UI. Use the arrow keys to select stacks and components to deploy.

atmos
tip

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

  • Use the right/left arrow keys to navigate between the "Commands", "Stacks" and "Components" views

  • Use the up/down arrow keys (or the mouse wheel) to select a command to execute, component and stack

  • Use the / key to filter/search for the commands, components, and stacks in the corresponding views

  • Use the Tab key to flip the "Stacks" and "Components" views. This is useful to be able to use the UI in two different modes:

    • Mode 1: Components in Stacks. Display all available stacks, select a stack, then show all the components that are defined in the selected stack

    • Mode 2: Stacks for Components. Display all available components, select a component, then show all the stacks where the selected component is configured

  • Press Enter to execute the selected command for the selected stack and component

Interactive Picker​

To get an idea of what it looks like, just try our quickstart and run the atmos command to start an interactive UI in the terminal. The recording below browses stacks and components, filters the list, flips between Mode 1 and Mode 2 with Tab, and finally presses Enter to execute validate component.

atmos (interactive)
00:00.0 / 00:00.0

Interactive mode is one way in — Atmos is a full CLI you can script and automate. Here's a taste of what it can do; browse the full list of examples for more.

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.