Skip to main content

Environment Variables

Most YAML settings in atmos.yaml can also be defined by environment variables. This is helpful for local development, CI/CD pipelines, and environment-specific overrides.

Configuration Variables​

These environment variables configure Atmos behavior and can override settings in atmos.yaml.

ATMOS_CLI_CONFIG_PATH

Where to find atmos.yaml. Path to a folder where atmos.yaml CLI config file is located (e.g. /config).

ATMOS_PROFILE

Activate configuration profiles (comma-separated). Equivalent to the --profile flag.

ATMOS_BASE_PATH

Base path to components and stacks folders.

  • YAML Path: base_path
ATMOS_VENDOR_BASE_PATH

Path to vendor configuration file or directory containing vendor files.

  • YAML Path: vendor.base_path

Component Variables​

ATMOS_COMPONENTS_TERRAFORM_COMMAND

The executable to be called by atmos when running Terraform commands.

  • YAML Path: components.terraform.command
ATMOS_COMPONENTS_TERRAFORM_BASE_PATH

Base path to Terraform components.

  • YAML Path: components.terraform.base_path
ATMOS_COMPONENTS_TERRAFORM_APPLY_AUTO_APPROVE

If set to true, auto-approve Terraform apply.

  • YAML Path: components.terraform.apply_auto_approve
ATMOS_COMPONENTS_TERRAFORM_DEPLOY_RUN_INIT

Run terraform init when executing atmos terraform deploy command.

  • YAML Path: components.terraform.deploy_run_init
ATMOS_COMPONENTS_TERRAFORM_INIT_RUN_RECONFIGURE

Run terraform init -reconfigure when executing atmos terraform commands.

  • YAML Path: components.terraform.init_run_reconfigure
ATMOS_COMPONENTS_TERRAFORM_INIT_PASS_VARS

Pass the generated varfile to terraform init using the --var-file flag.

  • YAML Path: components.terraform.init.pass_vars
ATMOS_COMPONENTS_TERRAFORM_PLAN_SKIP_PLANFILE

Skip writing the plan to a file by not passing the -out flag.

  • YAML Path: components.terraform.plan.skip_planfile
ATMOS_COMPONENTS_TERRAFORM_AUTO_GENERATE_BACKEND_FILE

If set to true, auto-generate Terraform backend config files.

  • YAML Path: components.terraform.auto_generate_backend_file
ATMOS_COMPONENTS_HELMFILE_COMMAND

The executable to be called by atmos when running Helmfile commands.

  • YAML Path: components.helmfile.command
ATMOS_COMPONENTS_HELMFILE_BASE_PATH

Path to helmfile components.

  • YAML Path: components.helmfile.base_path
ATMOS_COMPONENTS_HELMFILE_USE_EKS

If set to true, download kubeconfig from EKS before executing atmos helmfile commands.

  • YAML Path: components.helmfile.use_eks
ATMOS_COMPONENTS_HELMFILE_KUBECONFIG_PATH

Path to write the kubeconfig file.

  • YAML Path: components.helmfile.kubeconfig_path
ATMOS_COMPONENTS_HELMFILE_HELM_AWS_PROFILE_PATTERN

Pattern for AWS profile to use when executing atmos helmfile commands.

  • YAML Path: components.helmfile.helm_aws_profile_pattern
ATMOS_COMPONENTS_HELMFILE_CLUSTER_NAME_PATTERN

Pattern for EKS cluster name to use when executing atmos helmfile commands.

  • YAML Path: components.helmfile.cluster_name_pattern

Stack Variables​

ATMOS_STACKS_BASE_PATH

Base path to Atmos stack manifests.

  • YAML Path: stacks.base_path
ATMOS_STACKS_INCLUDED_PATHS

List of paths to use as top-level stack manifests.

  • YAML Path: stacks.included_paths
ATMOS_STACKS_EXCLUDED_PATHS

List of paths to not consider as top-level stacks.

  • YAML Path: stacks.excluded_paths
ATMOS_STACKS_NAME_PATTERN

Stack name pattern to use as Atmos stack names.

  • YAML Path: stacks.name_pattern
ATMOS_STACKS_NAME_TEMPLATE

Stack name Golang template to use as Atmos stack names.

  • YAML Path: stacks.name_template

Workflow and Schema Variables​

ATMOS_WORKFLOWS_BASE_PATH

Base path to Atmos workflows.

  • YAML Path: workflows.base_path
ATMOS_SCHEMAS_JSONSCHEMA_BASE_PATH

Base path to JSON schemas for component validation.

  • YAML Path: schemas.jsonschema.base_path
ATMOS_SCHEMAS_OPA_BASE_PATH

Base path to OPA policies for component validation.

  • YAML Path: schemas.opa.base_path
ATMOS_SCHEMAS_ATMOS_MANIFEST

Path to JSON Schema to validate Atmos stack manifests.

  • YAML Path: schemas.atmos.manifest

Logging and Profiling Variables​

ATMOS_LOGS_FILE

The file to write Atmos logs to (/dev/stdout, /dev/stderr, /dev/null, or a file path).

  • YAML Path: logs.file
ATMOS_LOGS_LEVEL

Logs level: Trace, Debug, Info, Warning, Off.

  • YAML Path: logs.level
ATMOS_PROFILER_ENABLED

Enable or disable the pprof HTTP profiling server.

  • YAML Path: profiler.enabled
ATMOS_PROFILER_HOST

Host address for the profiling server.

  • YAML Path: profiler.host
ATMOS_PROFILER_PORT

Port for the profiling server.

  • YAML Path: profiler.port
ATMOS_PROFILE_FILE

Write profiling data to the specified file.

  • YAML Path: profiler.file
ATMOS_PROFILE_TYPE

Type of profile to collect: cpu, heap, allocs, goroutine, block, mutex, threadcreate, trace.

  • YAML Path: profiler.profile_type

Settings Variables​

ATMOS_SETTINGS_LIST_MERGE_STRATEGY

Specifies how lists are merged: replace, append, merge.

  • YAML Path: settings.list_merge_strategy
ATMOS_VERSION_CHECK_ENABLED

Enable/disable Atmos version checks for updates.

  • YAML Path: version.check.enabled

Authentication Variables​

ATMOS_GITHUB_TOKEN

Bearer token for GitHub API requests, enabling authentication for private repositories.

ATMOS_GITHUB_USERNAME

GitHub username for OCI registry authentication to ghcr.io.

  • YAML Path: settings.github_username
ATMOS_BITBUCKET_TOKEN

App password for Bitbucket API requests.

ATMOS_BITBUCKET_USERNAME

Username for Bitbucket authentication.

ATMOS_GITLAB_TOKEN

Personal Access Token (PAT) for GitLab authentication.

Context Variables​

Some commands spawn interactive shells with environment variables set to provide context. These are set by Atmos, not by users:

ATMOS_COMPONENT
The name of the active component.
ATMOS_SHELL_WORKING_DIR
The directory from which native commands should be run.
ATMOS_SHLVL
The depth of Atmos shell nesting. When present, indicates shell was spawned by Atmos.
ATMOS_STACK
The name of the active stack.
ATMOS_TERRAFORM_WORKSPACE
The name of the Terraform workspace in which Terraform commands should be run.
PS1
When a custom shell prompt has been configured, the prompt is set via PS1.
TF_CLI_ARGS_*
Terraform CLI arguments to be passed to Terraform commands.

See Also​