Skip to content

Commit

Permalink
chore: docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
levkohimins committed Dec 20, 2024
1 parent 1a21c47 commit 5706817
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
18 changes: 18 additions & 0 deletions docs/_docs/04_reference/cli-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ This page documents the CLI commands and options available with Terragrunt:
- [scaffold](#scaffold)
- [catalog](#catalog)
- [graph](#graph)
- [exec](#exec)
- [CLI options](#cli-options)
- [auth-provider-cmd](#auth-provider-cmd)
- [config](#config)
Expand Down Expand Up @@ -101,6 +102,7 @@ This page documents the CLI commands and options available with Terragrunt:
- [experiment-mode](#experiment-mode)
- [strict-control](#strict-control)
- [strict-mode](#strict-mode)
- [in-download-dir](#in-download-dir)

## CLI commands

Expand All @@ -124,6 +126,7 @@ Terragrunt supports the following CLI commands:
- [scaffold](#scaffold)
- [catalog](#catalog)
- [graph](#graph)
- [exec](#exec)

### All OpenTofu/Terraform built-in commands

Expand Down Expand Up @@ -743,6 +746,10 @@ Notes:

- destroy will be executed only on subset of services dependent from `eks-service-3`

### exec

Execute a command using Terragrunt.

## CLI options

The currently available options are:
Expand Down Expand Up @@ -834,6 +841,7 @@ The currently available options are:
- [experiment-mode](#experiment-mode)
- [strict-control](#strict-control)
- [strict-mode](#strict-mode)
- [in-download-dir](#in-download-dir)

### config

Expand Down Expand Up @@ -1936,3 +1944,13 @@ For more information, see the [Strict Mode](/docs/reference/strict-mode) documen
Enable all strict controls that opt-in future breaking changes in Terragrunt.

For more information, see the [Strict Mode](/docs/reference/strict-mode) documentation.

### in-download-dir

**CLI Arg**: `--in-download-dir`<br/>
**Environment Variable**: `TG_IN_DOWNLOAD_DIR`<br/>
**Commands**:

- [exec](#exec)

Run the provided command in the download directory.
5 changes: 1 addition & 4 deletions internal/strict/strict.go
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,7 @@ var StrictControls = Controls{
Error: errors.Errorf("The `--%s` flag is no longer supported. Use `--terragrunt-log-format=json` instead.", TfLogJSON),
Warning: fmt.Sprintf("The `--%s` flag is deprecated and will be removed in a future version. Use `--terragrunt-log-format=json` instead.", TfLogJSON),
},
RenamedFlag: {
Error: errors.Errorf("The flag with `--terragrunt` prefix is no longer supported. Use without prefix instead."),
Warning: "The flag with `--terragrunt` prefix is deprecated and will be removed in a future version. Use without prefix instead.",
},
RenamedFlag: {},
RootTerragruntHCL: {
Error: errors.Errorf("Using `terragrunt.hcl` as the root of Terragrunt configurations is an anti-pattern, and no longer supported. Use a differently named file like `root.hcl` instead. For more information, see https://terragrunt.gruntwork.io/docs/migrate/migrating-from-root-terragrunt-hcl"),
Warning: "Using `terragrunt.hcl` as the root of Terragrunt configurations is an anti-pattern, and no longer recommended. In a future version of Terragrunt, this will result in an error. You are advised to use a differently named file like `root.hcl` instead. For more information, see https://terragrunt.gruntwork.io/docs/migrate/migrating-from-root-terragrunt-hcl",
Expand Down

0 comments on commit 5706817

Please sign in to comment.