From 76a206c870ea773a0f5bd25b797d99ec9ea8f8ad Mon Sep 17 00:00:00 2001 From: Yousif Akbar <11247449+yhakbar@users.noreply.github.com> Date: Fri, 15 Aug 2025 08:14:12 -0400 Subject: [PATCH] chore: Addressing review feedback --- .../docs/06-migrate/03-cli-redesign.md | 109 +++++++++--------- .../06_migration_guides/03-cli-redesign.md | 109 +++++++++--------- 2 files changed, 112 insertions(+), 106 deletions(-) diff --git a/docs-starlight/src/content/docs/06-migrate/03-cli-redesign.md b/docs-starlight/src/content/docs/06-migrate/03-cli-redesign.md index 8e6e69d784..4f8e94d8d5 100644 --- a/docs-starlight/src/content/docs/06-migrate/03-cli-redesign.md +++ b/docs-starlight/src/content/docs/06-migrate/03-cli-redesign.md @@ -65,60 +65,63 @@ You can find the new flag names in the [CLI reference](/docs/reference/cli/) (in Below is a comprehensive mapping of old CLI flag names to their modern counterparts: -| Old Flag | New Flag | -|----------|----------| -| `--terragrunt-config` | `--config` | -| `--terragrunt-working-dir` | `--working-dir` | -| `--terragrunt-download-dir` | `--download-dir` | -| `--terragrunt-source` | `--source` | -| `--terragrunt-source-map` | `--source-map` | -| `--terragrunt-source-update` | `--source-update` | -| `--terragrunt-iam-role` | `--iam-assume-role` | -| `--terragrunt-iam-assume-role-duration` | `--iam-assume-role-duration` | -| `--terragrunt-iam-web-identity-token` | `--iam-assume-role-web-identity-token` | -| `--terragrunt-ignore-dependency-errors` | `--queue-ignore-errors` | -| `--terragrunt-excludes-file` | `--queue-excludes-file` | -| `--terragrunt-exclude-dir` | `--queue-exclude-dir` | -| `--terragrunt-include-dir` | `--queue-include-dir` | -| `--terragrunt-strict-include` | `--queue-strict-include` | -| `--terragrunt-ignore-dependency-order` | `--queue-ignore-dag-order` | -| `--terragrunt-ignore-external-dependencies` | `--queue-exclude-external` | -| `--terragrunt-include-external-dependencies` | `--queue-include-external` | -| `--terragrunt-strict-validate` | `--strict-validate` | -| `--terragrunt-parallelism` | `--parallelism` | -| `--terragrunt-debug` | `--inputs-debug` | -| `--terragrunt-log-level` | `--log-level` | -| `--terragrunt-log-format` | `--log-format` | -| `--terragrunt-log-custom-format` | `--log-custom-format` | -| `--terragrunt-log-disable` | `--log-disable` | -| `--terragrunt-log-show-abs-paths` | `--log-show-abs-paths` | -| `--terragrunt-no-color` | `--no-color` | -| `--terragrunt-check` | `--check` | -| `--terragrunt-diff` | `--diff` | -| `--terragrunt-hclfmt-file` | `--file` | -| `--terragrunt-hclfmt-exclude-dir` | `--exclude-dir` | -| `--terragrunt-hclfmt-stdin` | `--stdin` | -| `--terragrunt-hclvalidate-json` | `--json` | -| `--terragrunt-hclvalidate-show-config-path` | `--show-config-path` | -| `--terragrunt-json-disable-dependent-modules` | `--disable-dependent-modules` | -| `--terragrunt-json-out` | `--out` | -| `--terragrunt-modules-that-include` | `--units-that-include` | -| `--terragrunt-queue-include-units-reading` | `--queue-include-units-reading` | +| Old Flag | New Flag | +| ------------------------------------------------- | -------------------------------------- | +| `--terragrunt-check` | `--check` | +| `--terragrunt-config` | `--config` | +| `--terragrunt-debug` | `--inputs-debug` | +| `--terragrunt-diff` | `--diff` | +| `--terragrunt-disable-bucket-update` | `--disable-bucket-update` | +| `--terragrunt-disable-command-validation` | `--disable-command-validation` | +| `--terragrunt-download-dir` | `--download-dir` | +| `--terragrunt-exclude-dir` | `--queue-exclude-dir` | +| `--terragrunt-excludes-file` | `--queue-excludes-file` | +| `--terragrunt-fail-on-state-bucket-creation` | `--backend-require-bootstrap` | | `--terragrunt-fetch-dependency-output-from-state` | `--dependency-fetch-output-from-state` | -| `--terragrunt-use-partial-parse-config-cache` | `--use-partial-parse-config-cache` | -| `--terragrunt-fail-on-state-bucket-creation` | `--backend-require-bootstrap` | -| `--terragrunt-disable-bucket-update` | `--disable-bucket-update` | -| `--terragrunt-disable-command-validation` | `--disable-command-validation` | -| `--terragrunt-provider-cache` | `--provider-cache` | -| `--terragrunt-provider-cache-dir` | `--provider-cache-dir` | -| `--terragrunt-provider-cache-hostname` | `--provider-cache-hostname` | -| `--terragrunt-provider-cache-port` | `--provider-cache-port` | -| `--terragrunt-provider-cache-token` | `--provider-cache-token` | -| `--terragrunt-provider-cache-registry-names` | `--provider-cache-registry-names` | -| `--terragrunt-out-dir` | `--out-dir` | -| `--terragrunt-json-out-dir` | `--json-out-dir` | -| `--terragrunt-forward-tf-stdout` | `--tf-forward-stdout` | -| `--terragrunt-no-destroy-dependencies-check` | `--no-destroy-dependencies-check` | +| `--terragrunt-forward-tf-stdout` | `--tf-forward-stdout` | +| `--terragrunt-hclfmt-exclude-dir` | `--exclude-dir` | +| `--terragrunt-hclfmt-file` | `--file` | +| `--terragrunt-hclfmt-stdin` | `--stdin` | +| `--terragrunt-hclvalidate-json` | `--json` | +| `--terragrunt-hclvalidate-show-config-path` | `--show-config-path` | +| `--terragrunt-iam-assume-role-duration` | `--iam-assume-role-duration` | +| `--terragrunt-iam-role` | `--iam-assume-role` | +| `--terragrunt-iam-web-identity-token` | `--iam-assume-role-web-identity-token` | +| `--terragrunt-ignore-dependency-errors` | `--queue-ignore-errors` | +| `--terragrunt-ignore-dependency-order` | `--queue-ignore-dag-order` | +| `--terragrunt-ignore-external-dependencies` | `--queue-exclude-external` | +| `--terragrunt-include-dir` | `--queue-include-dir` | +| `--terragrunt-include-external-dependencies` | `--queue-include-external` | +| `--terragrunt-json-disable-dependent-modules` | `--disable-dependent-modules` | +| `--terragrunt-json-out-dir` | `--json-out-dir` | +| `--terragrunt-json-out` | `--out` | +| `--terragrunt-log-custom-format` | `--log-custom-format` | +| `--terragrunt-log-disable` | `--log-disable` | +| `--terragrunt-log-format` | `--log-format` | +| `--terragrunt-log-level` | `--log-level` | +| `--terragrunt-log-show-abs-paths` | `--log-show-abs-paths` | +| `--terragrunt-modules-that-include` | `--units-that-include` | +| `--terragrunt-no-auto-approve` | `--no-auto-approve` | +| `--terragrunt-no-auto-init` | `--no-auto-init` | +| `--terragrunt-no-auto-retry` | `--no-auto-retry` | +| `--terragrunt-no-color` | `--no-color` | +| `--terragrunt-no-destroy-dependencies-check` | `--no-destroy-dependencies-check` | +| `--terragrunt-out-dir` | `--out-dir` | +| `--terragrunt-parallelism` | `--parallelism` | +| `--terragrunt-provider-cache-dir` | `--provider-cache-dir` | +| `--terragrunt-provider-cache-hostname` | `--provider-cache-hostname` | +| `--terragrunt-provider-cache-port` | `--provider-cache-port` | +| `--terragrunt-provider-cache-registry-names` | `--provider-cache-registry-names` | +| `--terragrunt-provider-cache-token` | `--provider-cache-token` | +| `--terragrunt-provider-cache` | `--provider-cache` | +| `--terragrunt-queue-include-units-reading` | `--queue-include-units-reading` | +| `--terragrunt-source-map` | `--source-map` | +| `--terragrunt-source-update` | `--source-update` | +| `--terragrunt-source` | `--source` | +| `--terragrunt-strict-include` | `--queue-strict-include` | +| `--terragrunt-strict-validate` | `--strict-validate` | +| `--terragrunt-use-partial-parse-config-cache` | `--use-partial-parse-config-cache` | +| `--terragrunt-working-dir` | `--working-dir` | ### Update environment variables diff --git a/docs/_docs/06_migration_guides/03-cli-redesign.md b/docs/_docs/06_migration_guides/03-cli-redesign.md index 0512e4cfdb..a686f72121 100644 --- a/docs/_docs/06_migration_guides/03-cli-redesign.md +++ b/docs/_docs/06_migration_guides/03-cli-redesign.md @@ -70,60 +70,63 @@ You can find the new flag names in the [CLI reference](/docs/reference/cli/) (in Below is a comprehensive mapping of old CLI flag names to their modern counterparts: -| Old Flag | New Flag | -|----------|----------| -| `--terragrunt-config` | `--config` | -| `--terragrunt-working-dir` | `--working-dir` | -| `--terragrunt-download-dir` | `--download-dir` | -| `--terragrunt-source` | `--source` | -| `--terragrunt-source-map` | `--source-map` | -| `--terragrunt-source-update` | `--source-update` | -| `--terragrunt-iam-role` | `--iam-assume-role` | -| `--terragrunt-iam-assume-role-duration` | `--iam-assume-role-duration` | -| `--terragrunt-iam-web-identity-token` | `--iam-assume-role-web-identity-token` | -| `--terragrunt-ignore-dependency-errors` | `--queue-ignore-errors` | -| `--terragrunt-excludes-file` | `--queue-excludes-file` | -| `--terragrunt-exclude-dir` | `--queue-exclude-dir` | -| `--terragrunt-include-dir` | `--queue-include-dir` | -| `--terragrunt-strict-include` | `--queue-strict-include` | -| `--terragrunt-ignore-dependency-order` | `--queue-ignore-dag-order` | -| `--terragrunt-ignore-external-dependencies` | `--queue-exclude-external` | -| `--terragrunt-include-external-dependencies` | `--queue-include-external` | -| `--terragrunt-strict-validate` | `--strict-validate` | -| `--terragrunt-parallelism` | `--parallelism` | -| `--terragrunt-debug` | `--inputs-debug` | -| `--terragrunt-log-level` | `--log-level` | -| `--terragrunt-log-format` | `--log-format` | -| `--terragrunt-log-custom-format` | `--log-custom-format` | -| `--terragrunt-log-disable` | `--log-disable` | -| `--terragrunt-log-show-abs-paths` | `--log-show-abs-paths` | -| `--terragrunt-no-color` | `--no-color` | -| `--terragrunt-check` | `--check` | -| `--terragrunt-diff` | `--diff` | -| `--terragrunt-hclfmt-file` | `--file` | -| `--terragrunt-hclfmt-exclude-dir` | `--exclude-dir` | -| `--terragrunt-hclfmt-stdin` | `--stdin` | -| `--terragrunt-hclvalidate-json` | `--json` | -| `--terragrunt-hclvalidate-show-config-path` | `--show-config-path` | -| `--terragrunt-json-disable-dependent-modules` | `--disable-dependent-modules` | -| `--terragrunt-json-out` | `--out` | -| `--terragrunt-modules-that-include` | `--units-that-include` | -| `--terragrunt-queue-include-units-reading` | `--queue-include-units-reading` | +| Old Flag | New Flag | +| ------------------------------------------------- | -------------------------------------- | +| `--terragrunt-check` | `--check` | +| `--terragrunt-config` | `--config` | +| `--terragrunt-debug` | `--inputs-debug` | +| `--terragrunt-diff` | `--diff` | +| `--terragrunt-disable-bucket-update` | `--disable-bucket-update` | +| `--terragrunt-disable-command-validation` | `--disable-command-validation` | +| `--terragrunt-download-dir` | `--download-dir` | +| `--terragrunt-exclude-dir` | `--queue-exclude-dir` | +| `--terragrunt-excludes-file` | `--queue-excludes-file` | +| `--terragrunt-fail-on-state-bucket-creation` | `--backend-require-bootstrap` | | `--terragrunt-fetch-dependency-output-from-state` | `--dependency-fetch-output-from-state` | -| `--terragrunt-use-partial-parse-config-cache` | `--use-partial-parse-config-cache` | -| `--terragrunt-fail-on-state-bucket-creation` | `--backend-require-bootstrap` | -| `--terragrunt-disable-bucket-update` | `--disable-bucket-update` | -| `--terragrunt-disable-command-validation` | `--disable-command-validation` | -| `--terragrunt-provider-cache` | `--provider-cache` | -| `--terragrunt-provider-cache-dir` | `--provider-cache-dir` | -| `--terragrunt-provider-cache-hostname` | `--provider-cache-hostname` | -| `--terragrunt-provider-cache-port` | `--provider-cache-port` | -| `--terragrunt-provider-cache-token` | `--provider-cache-token` | -| `--terragrunt-provider-cache-registry-names` | `--provider-cache-registry-names` | -| `--terragrunt-out-dir` | `--out-dir` | -| `--terragrunt-json-out-dir` | `--json-out-dir` | -| `--terragrunt-forward-tf-stdout` | `--tf-forward-stdout` | -| `--terragrunt-no-destroy-dependencies-check` | `--no-destroy-dependencies-check` | +| `--terragrunt-forward-tf-stdout` | `--tf-forward-stdout` | +| `--terragrunt-hclfmt-exclude-dir` | `--exclude-dir` | +| `--terragrunt-hclfmt-file` | `--file` | +| `--terragrunt-hclfmt-stdin` | `--stdin` | +| `--terragrunt-hclvalidate-json` | `--json` | +| `--terragrunt-hclvalidate-show-config-path` | `--show-config-path` | +| `--terragrunt-iam-assume-role-duration` | `--iam-assume-role-duration` | +| `--terragrunt-iam-role` | `--iam-assume-role` | +| `--terragrunt-iam-web-identity-token` | `--iam-assume-role-web-identity-token` | +| `--terragrunt-ignore-dependency-errors` | `--queue-ignore-errors` | +| `--terragrunt-ignore-dependency-order` | `--queue-ignore-dag-order` | +| `--terragrunt-ignore-external-dependencies` | `--queue-exclude-external` | +| `--terragrunt-include-dir` | `--queue-include-dir` | +| `--terragrunt-include-external-dependencies` | `--queue-include-external` | +| `--terragrunt-json-disable-dependent-modules` | `--disable-dependent-modules` | +| `--terragrunt-json-out-dir` | `--json-out-dir` | +| `--terragrunt-json-out` | `--out` | +| `--terragrunt-log-custom-format` | `--log-custom-format` | +| `--terragrunt-log-disable` | `--log-disable` | +| `--terragrunt-log-format` | `--log-format` | +| `--terragrunt-log-level` | `--log-level` | +| `--terragrunt-log-show-abs-paths` | `--log-show-abs-paths` | +| `--terragrunt-modules-that-include` | `--units-that-include` | +| `--terragrunt-no-auto-approve` | `--no-auto-approve` | +| `--terragrunt-no-auto-init` | `--no-auto-init` | +| `--terragrunt-no-auto-retry` | `--no-auto-retry` | +| `--terragrunt-no-color` | `--no-color` | +| `--terragrunt-no-destroy-dependencies-check` | `--no-destroy-dependencies-check` | +| `--terragrunt-out-dir` | `--out-dir` | +| `--terragrunt-parallelism` | `--parallelism` | +| `--terragrunt-provider-cache-dir` | `--provider-cache-dir` | +| `--terragrunt-provider-cache-hostname` | `--provider-cache-hostname` | +| `--terragrunt-provider-cache-port` | `--provider-cache-port` | +| `--terragrunt-provider-cache-registry-names` | `--provider-cache-registry-names` | +| `--terragrunt-provider-cache-token` | `--provider-cache-token` | +| `--terragrunt-provider-cache` | `--provider-cache` | +| `--terragrunt-queue-include-units-reading` | `--queue-include-units-reading` | +| `--terragrunt-source-map` | `--source-map` | +| `--terragrunt-source-update` | `--source-update` | +| `--terragrunt-source` | `--source` | +| `--terragrunt-strict-include` | `--queue-strict-include` | +| `--terragrunt-strict-validate` | `--strict-validate` | +| `--terragrunt-use-partial-parse-config-cache` | `--use-partial-parse-config-cache` | +| `--terragrunt-working-dir` | `--working-dir` | ### Update environment variables