Skip to content

Commit 5317683

Browse files
committed
Update docs UI and screengrabs
1 parent c404f4a commit 5317683

167 files changed

Lines changed: 16257 additions & 622 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

examples/quick-start-simple/README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,17 @@ cd examples/quick-start-simple
1818
# List all stacks
1919
atmos list stacks
2020

21-
# Describe the weather component in dev
22-
atmos describe component weather -s dev
21+
# List component instances in dev
22+
atmos list instances -s dev
2323

24-
# Plan the weather component
25-
atmos terraform plan weather -s dev
24+
# Describe the station component in dev
25+
atmos describe component station -s dev
26+
27+
# Preview all Terraform components in dev
28+
atmos terraform plan --all -s dev
29+
30+
# Deploy all Terraform components in dev
31+
atmos terraform deploy --all -s dev
2632
```
2733

2834
## Key Files

website/blog/2026-05-30-custom-commands-step-types.mdx

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
22
slug: custom-commands-step-types
3-
title: "Introducing 25+ Interactive Step Types for Workflows and Custom Commands"
3+
title: "Introducing 25+ Interactive Step Types for Custom Commands and Workflows"
44
authors: [osterman]
55
tags: [feature, dx]
66
date: 2026-05-30
77
---
88

9-
Atmos now includes 25+ interactive step types for both workflows and custom commands. Build interactive CLI wizards, collect user input, display rich output, and control execution flow—all directly in your `atmos.yaml` without external scripts.
9+
Atmos now includes 25+ interactive step types for custom commands and workflows. Build polished CLI commands, collect user input, display rich output, and control execution flow—all directly in your `atmos.yaml` without external scripts.
1010

1111
<!--truncate-->
1212

1313
## What's New
1414

15-
We've built a unified execution engine (`pkg/runner`) that powers both workflows and custom commands with the same rich step types:
15+
We've built a unified execution engine (`pkg/runner`) that powers custom commands and workflows with the same rich step types:
1616

1717
- **Interactive**: `input`, `confirm`, `choose`, `filter`, `file`, `write`
18-
- **UI Messages**: `success`, `info`, `warn`, `error`, `markdown`
18+
- **UI Messages**: `toast`, `markdown`
1919
- **Output**: `spin`, `table`, `pager`, `format`, `join`, `style`, `linebreak`, `log`
2020
- **Terminal**: `alert`, `title`, `clear`, `env`, `exit`
2121
- **Command**: `shell`, `atmos`
@@ -26,18 +26,18 @@ The `shell` and `atmos` types continue to work exactly as before—this is purel
2626

2727
Previously, building interactive CLI experiences required shell scripts and external tools like `gum` or `fzf`. Now you can create guided deployment wizards, configuration tools, and interactive runbooks natively in Atmos.
2828

29-
**For workflows:** Define multi-step automation with user prompts, confirmations, and rich feedback.
30-
3129
**For custom commands:** Users discover your interactive commands via `atmos help` and get a polished experience.
3230

31+
**For workflows:** Define multi-step automation with user prompts, confirmations, and rich feedback.
32+
3333
## How to Use It
3434

35-
### Workflow Example
35+
### Custom Command Example
3636

37-
```yaml title="stacks/workflows/deploy.yaml"
38-
workflows:
39-
deploy:
40-
description: Interactive deployment workflow
37+
```yaml title="atmos.yaml"
38+
commands:
39+
- name: deploy-wizard
40+
description: Interactive deployment wizard
4141
steps:
4242
- name: env
4343
type: choose
@@ -48,49 +48,48 @@ workflows:
4848
- name: confirm
4949
type: confirm
5050
prompt: "Deploy to {{ .steps.env.value }}?"
51+
default: false
5152

5253
- name: deploy
5354
type: atmos
5455
command: terraform apply vpc -s {{ .steps.env.value }}
5556

56-
- type: success
57+
- name: done
58+
type: toast
59+
level: success
5760
content: "Deployment to {{ .steps.env.value }} completed!"
5861
```
5962

60-
Run with: `atmos workflow deploy -f deploy`
63+
Run with: `atmos deploy-wizard`
6164

62-
### Custom Command Example
65+
### Workflow Example
6366

64-
```yaml title="atmos.yaml"
65-
commands:
66-
- name: deploy-wizard
67-
description: Interactive deployment wizard
67+
```yaml title="stacks/workflows/deploy.yaml"
68+
workflows:
69+
deploy:
70+
description: Interactive deployment workflow
6871
steps:
6972
- name: env
7073
type: choose
7174
prompt: "Select target environment"
7275
options: [dev, staging, prod]
7376
default: dev
7477

75-
- name: prod_warning
76-
type: warn
77-
content: "You are about to deploy to PRODUCTION!"
78-
7978
- name: confirm
8079
type: confirm
8180
prompt: "Deploy to {{ .steps.env.value }}?"
82-
default: false
8381

8482
- name: deploy
8583
type: atmos
8684
command: terraform apply vpc -s {{ .steps.env.value }}
8785

8886
- name: done
89-
type: success
87+
type: toast
88+
level: success
9089
content: "Deployment to {{ .steps.env.value }} completed!"
9190
```
9291

93-
Run with: `atmos deploy-wizard`
92+
Run with: `atmos workflow deploy -f deploy`
9493

9594
### Multi-Select Components
9695

@@ -147,7 +146,8 @@ commands:
147146
options: [low, medium, high, critical]
148147
default: medium
149148

150-
- type: success
149+
- type: toast
150+
level: success
151151
content: |
152152
Ticket created:
153153
Title: {{ .steps.title.value }}

website/docs/cli/commands/ci/cache/delete.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Like [`list`](/cli/commands/ci/cache/list), `delete` administers the cache over
2929
</div>
3030
</ActionCard>
3131

32-
<Screengrab title="atmos ci cache delete" slug="atmos-ci-cache-delete" />
32+
<Screengrab title="atmos ci cache delete --help" slug="atmos-ci-cache-delete--help" />
3333

3434
## Usage
3535

website/docs/cli/commands/ci/cache/list.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ List CI cache entries, optionally filtered by key prefix. Newest entries are lis
2929
</div>
3030
</ActionCard>
3131

32-
<Screengrab title="atmos ci cache list" slug="atmos-ci-cache-list" />
32+
<Screengrab title="atmos ci cache list --help" slug="atmos-ci-cache-list--help" />
3333

3434
## Usage
3535

website/docs/cli/commands/ci/cache/paths.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Print the resolved cache **key**, **paths**, and **restore-keys** so a native ca
2525
</div>
2626
</ActionCard>
2727

28-
<Screengrab title="atmos ci cache paths" slug="atmos-ci-cache-paths" />
28+
<Screengrab title="atmos ci cache paths --help" slug="atmos-ci-cache-paths--help" />
2929

3030
## Usage
3131

website/docs/cli/commands/ci/cache/restore.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Restore the CI cache into the well-known cache directory. The exact key is looke
2929
</div>
3030
</ActionCard>
3131

32-
<Screengrab title="atmos ci cache restore" slug="atmos-ci-cache-restore" />
32+
<Screengrab title="atmos ci cache restore --help" slug="atmos-ci-cache-restore--help" />
3333

3434
## Usage
3535

website/docs/cli/commands/ci/cache/save.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Archive the cache root (the toolchain and anything else under it) and upload it
2929
</div>
3030
</ActionCard>
3131

32-
<Screengrab title="atmos ci cache save" slug="atmos-ci-cache-save" />
32+
<Screengrab title="atmos ci cache save --help" slug="atmos-ci-cache-save--help" />
3333

3434
## Usage
3535

website/docs/cli/commands/ci/status.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Display CI status for the current branch, including status checks, pull request
2525
</div>
2626
</ActionCard>
2727

28-
<Screengrab title="atmos ci status" slug="atmos-ci-status" />
28+
<Screengrab title="atmos ci status --help" slug="atmos-ci-status--help" />
2929

3030
## Usage
3131

website/docs/cli/commands/profile/profile-show.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import Intro from '@site/src/components/Intro';
1212
Use this command to display detailed information about a specific configuration profile, including its metadata, configuration files, and usage instructions.
1313
</Intro>
1414

15-
<Screengrab title="atmos profile show developer" slug="atmos-profile-show" />
15+
<Screengrab title="atmos profile show --help" slug="atmos-profile-show--help" />
1616

1717
## Usage
1818

website/docs/cli/configuration/components/terraform.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,5 +350,5 @@ backend.tf.json
350350
- [Component Configuration Overview](/cli/configuration/components)
351351
- [Stack Configuration](/cli/configuration/stacks)
352352
- [Terraform Components](/components/terraform)
353-
- [Terraform Backend](/stacks/backend)
353+
- [Terraform Backend](/stacks/terraform/backend)
354354
- [Generate Terraform Files](/stacks/generate)

0 commit comments

Comments
 (0)