Back to Terragrunt

JSON format

docs/src/data/flags/stack-output-format.mdx

1.0.31.9 KB
Original Source

Specifies the output format for stack outputs. Available formats are:

  • default - Format output as HCL (default)
  • json - Format output as JSON for machine readability
  • raw - Format output as raw string for shell script integration
FormatDescription
defaultFormat output as HCL.
jsonFormat output as JSON. This can be useful for integrations with other tools.
rawFormat output as a simple raw string. Useful for integration into bash scripts.

Example:

bash
# JSON format
terragrunt stack output --format json

# Raw format
terragrunt stack output --format raw project1_app1.custom_value1

json format

To retrieve outputs in structured JSON format:

bash
$ terragrunt stack output --format json project1_app2
{
  "project1_app2": {
    "complex": {
      "delta": 0.02,
      "id": 2,
      "name": "name2",
      "timestamp": "2025-02-07T21:05:51Z"
    },
    "custom_value2": "value2",
    "data": "app2",
    "list": [
      "a",
      "b",
      "c"
    ]
  }
}

Accessing a specific list inside JSON format:

bash
$ terragrunt stack output --format json project1_app2.complex_list
{
  "project1_app2.complex_list": [
    {
      "delta": 0.02,
      "id": 2,
      "name": "name2",
      "timestamp": "2025-02-07T21:05:51Z"
    },
    {
      "delta": 0.03,
      "id": 2,
      "name": "name3",
      "timestamp": "2025-02-07T21:05:51Z"
    }
  ]
}

raw format

The raw format returns outputs as plain values without additional structure. When accessing lists or structured outputs, indexes are required to extract values.

Retrieving a simple value:

bash
$ terragrunt stack output --format raw project1_app2.data
app2