atmos terraform migrate list

Use atmos terraform migrate list to inspect which Terraform component instances have kind: tfmigrate hooks and which history settings Atmos will expose.

Experimental

atmos terraform migrate list --help

 █████  ████████ ███    ███  ██████  ███████ 
██   ██    ██    ████  ████ ██    ██ ██      
███████    ██    ██ ████ ██ ██    ██ ███████ 
██   ██    ██    ██  ██  ██ ██    ██      ██ 
██   ██    ██    ██      ██  ██████  ███████ 
                                             

👽 test darwin/arm64

List Terraform component instances with tfmigrate context

USAGE

                                                        
    $ atmos terraform migrate list [component] [flags]  
                                                        

FLAGS

      --all               List tfmigrate context for all components in all stacks

      --columns strings   Columns to display

      --delimiter string  Delimiter for CSV/TSV output

  -f, --format string     Output format: table, json, yaml, csv, tsv (default table)

  -h, --help              help for list

      --sort string       Sort by column:order (for example, stack:asc,component:desc)


GLOBAL FLAGS

      --ai                        Enable AI-powered analysis of command output

      --append-user-agent string  Customize User-Agent string in Terraform provider requests (sets
                                  TF_APPEND_USER_AGENT)

      --base-path string          Base path for Atmos project

  -C, --chdir string              Change working directory before executing the command (run as if Atmos started in
                                  this directory)

      --clone-target-ref          Clone the target reference with which to compare the current branch

      --components strings        Filter by specific components

      --config strings            Paths to configuration files (comma-separated or repeated flag)

      --config-path strings       Paths to search for Atmos configuration (comma-separated or repeated flag)

      --dry-run                   Perform dry run without making actual changes

      --force-color               Force color output even when not a TTY (useful for screenshots)

      --force-tty                 Force TTY mode with sane defaults when terminal detection fails (useful for
                                  screenshots)

      --heatmap                   Show performance heatmap visualization after command execution (includes P95
                                  latency)

      --heatmap-mode string       Heatmap visualization mode: bar, sparkline, table (press 1-3 to switch in TUI)
                                  (default bar)

  -i, --identity string           Specify the identity to authenticate to before running Terraform commands. Use
                                  without value to interactively select.

      --include-dependents        For each affected component, detect the dependent components and process them in the
                                  dependency order

      --init-pass-vars            Pass the generated varfile to terraform init using --var-file flag (OpenTofu feature)

      --interactive               Enable interactive prompts for missing required flags, optional value flags using
                                  the sentinel pattern, and missing positional arguments (requires TTY, disabled in
                                  CI) (default true)

      --logs-file string          The file to write Atmos logs to. Logs can be written to any file or any standard
                                  file descriptor, including '/dev/stdout', '/dev/stderr' and '/dev/null' (default
                                  /dev/stderr)

      --logs-level string         Logs level. Supported log levels are Trace, Debug, Info, Warning, Off. If the log
                                  level is set to Off, Atmos will not log any messages (default Warning)

      --mask                      Enable automatic masking of sensitive data in output (use --mask=false to disable)
                                  (default true)

      --no-color                  Disable color output

      --pager string              Enable pager for output (--pager or --pager=true to enable, --pager=false to disable, --
                                  pager=less to use specific pager)

      --process-functions         Enable/disable YAML functions processing in Atmos stack manifests (default true)

      --process-templates         Enable/disable Go template processing in Atmos stack manifests (default true)

      --profile strings           Activate configuration profiles (comma-separated or repeated flag)

      --profile-file string       Write profiling data to file instead of starting server

      --profile-type string       Type of profile to collect when using --profile-file. Options: cpu, heap, allocs,
                                  goroutine, block, mutex, threadcreate, trace (default cpu)

      --profiler-enabled          Enable pprof profiling server

      --profiler-host string      Host for pprof profiling server (default localhost)

      --profiler-port int         Port for pprof profiling server (default 6060)

  -q, --query string              Execute atmos terraform command on components filtered by a YQ expression

      --redirect-stderr string    File descriptor to redirect stderr to. Errors can be redirected to any file or any
                                  standard file descriptor (including '/dev/null')

      --ref string                Git reference with which to compare the current branch

      --repo-path string          Filesystem path to the already cloned target repository with which to compare the
                                  current branch

      --sha string                Git commit SHA with which to compare the current branch

      --skill strings             Specify skills for AI analysis context (comma-separated or repeated flag, requires --
                                  ai)

      --skip strings              Skip executing specific YAML functions in the Atmos stack manifests

      --skip-hooks string         Skip lifecycle hooks for this invocation. Use --skip-hooks (no value) to skip all, or --
                                  skip-hooks=name1,name2 to skip specific hooks by name

      --skip-init                 Skip terraform init before running command

      --ssh-key string            Path to PEM-encoded private key to clone private repos using SSH

      --ssh-key-password string   Encryption password for the PEM-encoded private key if the key contains a password-
                                  encrypted PEM block

  -s, --stack string              Stack name

      --upload-status             Upload plan status to Atmos Pro

      --use-version string        Use a specific version of Atmos (e.g., --use-version=1.160.0)

  -v, --verbose                   Enable verbose error output with full context, stack traces, and detailed
                                  information

Usage

atmos terraform migrate list [component] [options]

Arguments

component

Optional component name filter.

Flags

--stack / -s

Filter results to a stack.

--identity / -i

Identity to authenticate before resolving stacks and component migration context. Environment variable: ATMOS_IDENTITY.

--components

Filter results to one or more component names.

--query

Filter component instances with a YQ expression.

--format / -f

Output format. Supported values: table, json, yaml, csv, tsv.

--columns

Columns to display. Use field names such as component, stack, workspace, hook, mode, history_bucket, and history_key.

--sort

Sort by column and order, for example stack:asc,component:asc.

--delimiter

Delimiter for CSV or TSV output.

Examples

List migration context for a stack:

atmos terraform migrate list -s plat-ue2-dev

List with an explicit identity:

atmos terraform migrate list -s plat-ue2-dev --identity aws-prod

Show history keys for matching components:

atmos terraform migrate list --query '.settings.requires_migration == true' --columns component --columns stack --columns history_key

Output JSON for automation (no [component] argument lists every component in every stack):

atmos terraform migrate list --format json

Output Columns

Default columns include component, stack, workspace, hook, mode, migration, config, history storage, history bucket, history key, and history role ARN.

Atmos scopes the history_key value by stack, component, and workspace:

tfmigrate/<stack>/<component>/<workspace>/history.json

Related

• atmos terraform migrate
• atmos terraform migrate plan
• atmos terraform migrate apply