From 17e9d21ef8989cffa183da50dee7663b308be88a Mon Sep 17 00:00:00 2001 From: Pedro Silva <73700426+pedromtsilva@users.noreply.github.com> Date: Sat, 27 Sep 2025 19:06:54 +0100 Subject: [PATCH 1/2] Fix inconsistencies in CLI documentation Updated command examples for clarity and accuracy regarding the use of the 'run' command in Terragrunt CLI, which was presenting itself with a repeated command definition. Also changed upper reference regarding the `graph` flag to match the definition on the bottom of the page. --- .../src/content/docs/07-migrate/03-cli-redesign.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs-starlight/src/content/docs/07-migrate/03-cli-redesign.md b/docs-starlight/src/content/docs/07-migrate/03-cli-redesign.md index 58d38df3dd..44b1a37ac8 100644 --- a/docs-starlight/src/content/docs/07-migrate/03-cli-redesign.md +++ b/docs-starlight/src/content/docs/07-migrate/03-cli-redesign.md @@ -208,25 +208,25 @@ terragrunt run -- workspace ls Similarly, commands like `graph` won't be supported as a shortcut, as `graph` is a now deprecated command in the Terragrunt CLI. Supporting it as a shortcut would be misleading, so you can use the `run` command to run it explicitly: ```bash -terragrunt run graph +terragrunt run --graph ``` You might want to explicitly indicate that the flag you are using is one for OpenTofu/Terraform, and not a Terragrunt flag. To do this, you can use the `--` argument to explicitly separate the Terragrunt flags from the OpenTofu/Terraform flags: ```bash -terragrunt run -- apply -auto-approve +terragrunt run -- apply -auto-approve ``` This usually isn't necessary, except when combining a complicated series of flags and arguments, which can be difficult to parse for the CLI. In addition to allowing for explicit invocation of OpenTofu/Terraform instead of using shortcuts, the `run` command also takes on the responsibilities of the now deprecated `run-all` and `graph` commands using flags. -For example, if you are currently using the `terragrunt run --all` command, you can switch to the `run` command with the `--all` flag instead. +For example, if you are currently using the `terragrunt run-all` command, you can switch to the `run` command with the `--all` flag instead. Before: ```bash -terragrunt run --all plan +terragrunt run-all plan ``` After: From ec254f009bd8b1f4e7e56f766e428d9454925dc5 Mon Sep 17 00:00:00 2001 From: Pedro Silva <73700426+pedromtsilva@users.noreply.github.com> Date: Sat, 27 Sep 2025 19:22:55 +0100 Subject: [PATCH 2/2] Update CLI command usage and flag indication Clarify usage of deprecated 'graph' command and flag separation. --- docs-starlight/src/content/docs/07-migrate/03-cli-redesign.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-starlight/src/content/docs/07-migrate/03-cli-redesign.md b/docs-starlight/src/content/docs/07-migrate/03-cli-redesign.md index 44b1a37ac8..45270614ce 100644 --- a/docs-starlight/src/content/docs/07-migrate/03-cli-redesign.md +++ b/docs-starlight/src/content/docs/07-migrate/03-cli-redesign.md @@ -208,7 +208,7 @@ terragrunt run -- workspace ls Similarly, commands like `graph` won't be supported as a shortcut, as `graph` is a now deprecated command in the Terragrunt CLI. Supporting it as a shortcut would be misleading, so you can use the `run` command to run it explicitly: ```bash -terragrunt run --graph +terragrunt run --graph plan ``` You might want to explicitly indicate that the flag you are using is one for OpenTofu/Terraform, and not a Terragrunt flag. To do this, you can use the `--` argument to explicitly separate the Terragrunt flags from the OpenTofu/Terraform flags: