# 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.

## Usage

```shell
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

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

Example output:

```yaml
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:

```shell
# 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:

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

### Troubleshooting

Verify the workdir configuration matches expectations:

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

## Related Commands

- [`atmos terraform workdir list`](/cli/commands/terraform/workdir/list) - List all workdirs
- [`atmos terraform workdir show`](/cli/commands/terraform/workdir/show) - Show workdir details
- [`atmos terraform workdir clean`](/cli/commands/terraform/workdir/clean) - Remove workdirs
- [`atmos describe component`](/cli/commands/describe/component) - Describe full component configuration