Skip to main content

atmos terraform workdir describe

Use this command to output the workdir configuration as a valid Atmos stack manifest snippet. This is useful for documenting or recreating workdir configurations.

atmos terraform workdir describe --help

Usage​

atmos terraform workdir describe <component> --stack <stack> [flags]

Arguments​

component
The name of the Terraform component whose workdir configuration you want to describe.

Flags​

-s, --stack
Required. The stack name for the component.

Examples​

Describe Workdir Configuration​

# Output workdir config as a YAML stack manifest snippet
atmos terraform workdir describe vpc --stack dev

Example output:

components:
    terraform:
        vpc:
            metadata:
                workdir:
                    content_hash: a60bbfad57c32f1d7acd08defd9f0bb7
                    created_at: "2026-01-15T10:30:00-05:00"
                    name: dev-vpc-bb03116d
                    path: .workdir/terraform/dev-vpc-bb03116d
                    source: components/terraform/vpc
                    updated_at: "2026-01-15T10:30:00-05:00"

Use Cases​

Documentation​

Generate documentation for how components are configured with workdirs:

# Document all workdir configurations
for stack in dev staging prod; do
  echo "# Stack: $stack"
  atmos terraform workdir describe vpc --stack $stack
  echo ""
done

Configuration Backup​

Export workdir configurations for backup or migration:

# Export workdir config to a file
atmos terraform workdir describe vpc --stack dev > vpc-workdir-config.yaml

Troubleshooting​

Verify the workdir configuration matches expectations:

# Check the resolved workdir path
atmos terraform workdir describe vpc --stack dev | grep "path:"

Related Commands​