Skip to main content

Describe Settings

The describe section of the atmos.yaml configures the behavior of the atmos describe command output.

Configuration​

atmos.yaml

describe:
  settings:
    # Include empty values in the describe output
    include_empty: false

Fields​

settings.include_empty

When set to true, includes fields with empty values (empty strings, empty arrays, null values) in the describe command output. Default: false (empty values are omitted for cleaner output).

Examples​

Show All Fields Including Empty​

To see all configuration fields even when they have no value:

atmos.yaml

describe:
  settings:
    include_empty: true

This is useful for:

  • Understanding the full schema of component configurations
  • Debugging why a field might not be set
  • Documentation purposes

Default Behavior (Cleaner Output)​

By default, empty values are omitted:

atmos.yaml

describe:
  settings:
    include_empty: false

This produces cleaner, more readable output focused on the values that are actually configured.

Describe Components and Stacks

Use the describe commands to inspect your component and stack configurations.