Skip to main content

Version Check

Configure automatic version checking and update notifications for Atmos CLI. Control how frequently Atmos checks for new releases and whether update notifications are displayed.

Configuration​

Version checking is configured in the version section:

atmos.yaml

version:
  check:
    enabled: true
    frequency: daily

Configuration Options​

version.check.enabled

Enable or disable automatic version checking. When disabled, Atmos will not check for updates unless explicitly requested with atmos version --check.

Default: true

Can also be set via ATMOS_VERSION_CHECK_ENABLED environment variable.

version.check.frequency

How often Atmos checks for new versions. Supports three formats:

Predefined Keywords:

  • minute — Check every minute
  • hourly — Check every hour
  • daily — Check once per day (default)
  • weekly — Check once per week
  • monthly — Check once per month
  • yearly — Check once per year

Duration with Suffix:

  • 1m — 1 minute
  • 5h — 5 hours
  • 2d — 2 days

Integer (seconds):

  • 3600 — Check every 3600 seconds (1 hour)

Default: daily

If an invalid value is provided, defaults to daily.

Examples​

Disable Version Checks​

To disable automatic version checking entirely:

atmos.yaml

version:
  check:
    enabled: false

Or via environment variable:

export ATMOS_VERSION_CHECK_ENABLED=false

Check Weekly​

For less frequent checks, such as weekly:

atmos.yaml

version:
  check:
    enabled: true
    frequency: weekly

Custom Frequency​

Set a custom check interval of 12 hours:

atmos.yaml

version:
  check:
    enabled: true
    frequency: 12h

Or using seconds:

atmos.yaml

version:
  check:
    enabled: true
    frequency: 43200  # 12 hours in seconds

Force Version Check​

To check for updates immediately, regardless of configuration:

atmos version --check

This bypasses the frequency setting and checks the Atmos releases page on GitHub for the latest version.

Environment Variables​

ATMOS_VERSION_CHECK_ENABLED
Override the version.check.enabled setting. Set to false to disable version checking.