Skip to main content

filter

The filter step type provides a searchable, optionally multi-select menu — the same fuzzy picker Atmos uses for interactive selection — so your custom commands and workflows can choose one or many values from long lists.

steps:
- name: components
type: filter
prompt: Select components
multiple: true
options:
- vpc
- eks
- rds

Fields

prompt
Required. Prompt text shown to the user.
options
Required. List of choices.
multiple
Set to true to allow more than one selection.
limit
Optional maximum number of selections.
default
Optional value used in a non-TTY environment (e.g. CI). For multi-select (multiple: true) it is a comma-separated list.

Interactive steps require a TTY; in a non-TTY environment such as CI, the step uses its default if set and otherwise errors. Multiple selections are available through {{ .steps.components.values }}.