docs: refactor terraform usage page by osterman · Pull Request #1952 · cloudposse/atmos

osterman · 2026-01-12T20:55:18Z

what

Refactored terraform usage.mdx from 871 to 149 lines into a focused overview page
Added Multi-Component Operations sections to terraform-plan, terraform-apply, terraform-deploy, and terraform-destroy command pages
Moved 300+ lines of multi-component examples and flag documentation to individual command pages
Eliminated 765 lines of duplicate content across documentation

why

The terraform usage page served as both a landing page and comprehensive reference, resulting in massive duplication. Multi-component operations documentation now lives in individual command pages where it's directly relevant, improving maintainability and following the pattern used by other command groups like describe.

references

Issue: Terraform usage page was not refactored after subcommands were broken out into separate pages.

Summary by CodeRabbit

Documentation
- Added comprehensive multi-component operations documentation for terraform apply, deploy, and plan commands, covering filtering flags and deployment modes including affected components and query-based selection.
- Reorganized terraform usage documentation with a new Command Modes section, streamlined examples, and improved navigation for single and multi-component workflows.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

- Refactored usage.mdx from 871 to 149 lines to focus on overview - Moved multi-component operations content to individual command pages - Added Multi-Component Operations sections to plan, apply, deploy, destroy - Each section documents --all, --affected, --components, --query usage - Includes examples and flags table for multi-component operations - Maintains path-based component resolution and key differences sections - Eliminates 765 lines of duplicate content across documentation Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

mergify · 2026-01-12T20:55:54Z

Warning

This PR exceeds the recommended limit of 1,000 lines.

Large PRs are difficult to review and may be rejected due to their size.

Please verify that this PR does not address multiple issues.
Consider refactoring it into smaller, more focused PRs to facilitate a smoother review process.

github-actions · 2026-01-12T20:56:22Z

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

The destroy command does not support --all or --affected flags. Only plan, apply, and deploy have these multi-component operations. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

coderabbitai · 2026-01-12T21:10:38Z

📝 Walkthrough

Walkthrough

This PR updates Terraform CLI documentation by adding a new "Multi-Component Operations" section to terraform-apply, terraform-deploy, and terraform-plan command docs, and reorganizes the usage page to streamline content from extensive examples to a concise "Command Modes" overview.

Changes

Cohort / File(s)	Summary
Multi-Component Operations Documentation `website/docs/cli/commands/terraform/terraform-apply.mdx`, `website/docs/cli/commands/terraform/terraform-deploy.mdx`, `website/docs/cli/commands/terraform/terraform-plan.mdx`	Added new "Multi-Component Operations" section describing how to execute commands across multiple components with filtering flags (--all, --affected, --components, --query, etc.). Includes usage patterns, warning about infrastructure changes, and multi-component flag reference. Note: content appears duplicated within each file.
Terraform Usage Documentation `website/docs/cli/commands/terraform/usage.mdx`	Major restructuring replacing extensive sections with streamlined "Command Modes" overview. Consolidated path-based resolution guidance, simplified multi-component usage examples, and removed detailed arguments/flags in favor of links to individual command pages.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~18 minutes

Possibly related PRs

docs: add comprehensive Terraform planfile documentation and command reference #1498 — Modifies the same Terraform CLI documentation files with overlapping multi-component and planfile usage content.

Suggested labels

no-release

Suggested reviewers

aknysh
jamengual

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: refactor terraform usage page' directly and accurately describes the primary change—refactoring the terraform usage documentation from 871 to 149 lines into a focused overview.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch osterman/terraform-usage-refactor

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 1527ee8 and 5da4c24.

📒 Files selected for processing (4)

website/docs/cli/commands/terraform/terraform-apply.mdx
website/docs/cli/commands/terraform/terraform-deploy.mdx
website/docs/cli/commands/terraform/terraform-plan.mdx
website/docs/cli/commands/terraform/usage.mdx

🧰 Additional context used

📓 Path-based instructions (2)

website/**

📄 CodeRabbit inference engine (.cursor/rules/atmos-rules.mdc)

website/**: Update website documentation in the website/ directory when adding new features, ensure consistency between CLI help text and website documentation, and follow the website's documentation structure and style
Keep website code in the website/ directory, follow the existing website architecture and style, and test website changes locally before committing
Keep CLI documentation and website documentation in sync and document new features on the website with examples and use cases

Files:

website/docs/cli/commands/terraform/terraform-deploy.mdx
website/docs/cli/commands/terraform/usage.mdx
website/docs/cli/commands/terraform/terraform-apply.mdx
website/docs/cli/commands/terraform/terraform-plan.mdx

website/docs/cli/commands/**/*.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

All CLI command documentation MUST include: frontmatter, Intro component, Screengrab, Usage section, Arguments/Flags in <dl> format, and Examples section

Files:

website/docs/cli/commands/terraform/terraform-deploy.mdx
website/docs/cli/commands/terraform/usage.mdx
website/docs/cli/commands/terraform/terraform-apply.mdx
website/docs/cli/commands/terraform/terraform-plan.mdx

🧠 Learnings (24)

📓 Common learnings

Learnt from: osterman
Repo: cloudposse/atmos PR: 1686
File: docs/prd/tool-dependencies-integration.md:58-64
Timestamp: 2025-12-13T06:07:37.766Z
Learning: cloudposse/atmos: For PRD docs (docs/prd/*.md), markdownlint issues like MD040/MD010/MD034 can be handled in a separate documentation cleanup commit and should not block the current PR.

Learnt from: Listener430
Repo: cloudposse/atmos PR: 934
File: tests/fixtures/scenarios/docs-generate/README.md.gotmpl:99-118
Timestamp: 2025-01-25T03:51:57.689Z
Learning: For the cloudposse/atmos repository, changes to template contents should be handled in dedicated PRs and are typically considered out of scope for PRs focused on other objectives.

Learnt from: samtholiya
Repo: cloudposse/atmos PR: 1466
File: cmd/markdown/atmos_toolchain_aliases.md:2-4
Timestamp: 2025-09-13T16:39:20.007Z
Learning: In the cloudposse/atmos repository, CLI documentation files in cmd/markdown/ follow a specific format that uses " $ atmos command" (with leading space and dollar sign prompt) in code blocks. This is the established project convention and should not be changed to comply with standard markdownlint rules MD040 and MD014.

Learnt from: samtholiya
Repo: cloudposse/atmos PR: 955
File: tests/snapshots/TestCLICommands_atmos_validate_editorconfig_--help.stdout.golden:0-0
Timestamp: 2025-01-19T15:49:15.593Z
Learning: In future commits, the help text for Atmos CLI commands should be limited to only show component and stack parameters for commands that actually use them. This applies to the example usage section in command help text.

Learnt from: CR
Repo: cloudposse/atmos PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-04T00:55:21.720Z
Learning: Applies to website/docs/cli/commands/**/*.mdx : All CLI command documentation MUST include: frontmatter, Intro component, Screengrab, Usage section, Arguments/Flags in `<dl>` format, and Examples section

Learnt from: CR
Repo: cloudposse/atmos PR: 0
File: .cursor/rules/atmos-rules.mdc:0-0
Timestamp: 2025-11-24T17:35:37.209Z
Learning: Applies to website/** : Keep CLI documentation and website documentation in sync and document new features on the website with examples and use cases

📚 Learning: 2025-06-23T02:14:30.937Z

Learnt from: aknysh
Repo: cloudposse/atmos PR: 1327
File: cmd/terraform.go:111-117
Timestamp: 2025-06-23T02:14:30.937Z
Learning: In cmd/terraform.go, flags for the DescribeAffected function are added dynamically at runtime when info.Affected is true. This is intentional to avoid exposing internal flags like "file", "format", "verbose", "include-spacelift-admin-stacks", "include-settings", and "upload" in the terraform command interface, while still providing them for the shared DescribeAffected function used by both `atmos describe affected` and `atmos terraform apply --affected`.

Applied to files:

website/docs/cli/commands/terraform/terraform-deploy.mdx
website/docs/cli/commands/terraform/usage.mdx
website/docs/cli/commands/terraform/terraform-apply.mdx
website/docs/cli/commands/terraform/terraform-plan.mdx

📚 Learning: 2025-10-07T00:25:16.333Z

Learnt from: osterman
Repo: cloudposse/atmos PR: 1498
File: website/src/components/Screengrabs/atmos-terraform-metadata--help.html:25-55
Timestamp: 2025-10-07T00:25:16.333Z
Learning: In Atmos CLI, subcommands inherit flags from their parent commands via Cobra's command inheritance. For example, `atmos terraform metadata --help` shows `--affected` and related flags inherited from the parent `terraform` command (defined in cmd/terraform.go), even though the metadata subcommand doesn't explicitly define these flags. This is expected Cobra behavior and auto-generated help screengrabs accurately reflect this inheritance.

Applied to files:

website/docs/cli/commands/terraform/terraform-deploy.mdx
website/docs/cli/commands/terraform/usage.mdx
website/docs/cli/commands/terraform/terraform-apply.mdx
website/docs/cli/commands/terraform/terraform-plan.mdx

📚 Learning: 2024-10-21T17:51:53.976Z

Learnt from: osterman
Repo: cloudposse/atmos PR: 727
File: internal/exec/terraform.go:114-118
Timestamp: 2024-10-21T17:51:53.976Z
Learning: When `atmos terraform clean --everything` is used without specifying a component and without the `--force` flag, prompt the user for confirmation before deleting all components. Use the `--force` flag to skip the confirmation prompt.

Applied to files:

website/docs/cli/commands/terraform/terraform-deploy.mdx
website/docs/cli/commands/terraform/usage.mdx
website/docs/cli/commands/terraform/terraform-apply.mdx
website/docs/cli/commands/terraform/terraform-plan.mdx

📚 Learning: 2025-01-19T15:49:15.593Z

Learnt from: samtholiya
Repo: cloudposse/atmos PR: 955
File: tests/snapshots/TestCLICommands_atmos_validate_editorconfig_--help.stdout.golden:0-0
Timestamp: 2025-01-19T15:49:15.593Z
Learning: In future commits, the help text for Atmos CLI commands should be limited to only show component and stack parameters for commands that actually use them. This applies to the example usage section in command help text.

Applied to files:

website/docs/cli/commands/terraform/terraform-deploy.mdx
website/docs/cli/commands/terraform/usage.mdx
website/docs/cli/commands/terraform/terraform-apply.mdx
website/docs/cli/commands/terraform/terraform-plan.mdx

📚 Learning: 2025-09-13T16:39:20.007Z

Learnt from: samtholiya
Repo: cloudposse/atmos PR: 1466
File: cmd/markdown/atmos_toolchain_aliases.md:2-4
Timestamp: 2025-09-13T16:39:20.007Z
Learning: In the cloudposse/atmos repository, CLI documentation files in cmd/markdown/ follow a specific format that uses " $ atmos command" (with leading space and dollar sign prompt) in code blocks. This is the established project convention and should not be changed to comply with standard markdownlint rules MD040 and MD014.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2025-10-10T23:51:36.597Z

Learnt from: osterman
Repo: cloudposse/atmos PR: 1599
File: internal/exec/terraform.go:394-402
Timestamp: 2025-10-10T23:51:36.597Z
Learning: In Atmos (internal/exec/terraform.go), when adding OpenTofu-specific flags like `--var-file` for `init`, do not gate them based on command name (e.g., checking if `info.Command == "tofu"` or `info.Command == "opentofu"`) because command names don't reliably indicate the actual binary being executed (symlinks, aliases). Instead, document the OpenTofu requirement in code comments and documentation, trusting users who enable the feature (e.g., `PassVars`) to ensure their terraform command points to an OpenTofu binary.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2025-01-09T22:37:01.004Z

Learnt from: samtholiya
Repo: cloudposse/atmos PR: 914
File: cmd/terraform_commands.go:260-265
Timestamp: 2025-01-09T22:37:01.004Z
Learning: In the terraform commands implementation (cmd/terraform_commands.go), the direct use of `os.Args[2:]` for argument handling is intentionally preserved to avoid extensive refactoring. While it could be improved to use cobra's argument parsing, such changes should be handled in a dedicated PR to maintain focus and minimize risk.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2026-01-04T00:55:21.720Z

Learnt from: CR
Repo: cloudposse/atmos PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-01-04T00:55:21.720Z
Learning: Applies to website/docs/cli/commands/**/*.mdx : All CLI command documentation MUST include: frontmatter, Intro component, Screengrab, Usage section, Arguments/Flags in `<dl>` format, and Examples section

Applied to files:

website/docs/cli/commands/terraform/usage.mdx
website/docs/cli/commands/terraform/terraform-apply.mdx
website/docs/cli/commands/terraform/terraform-plan.mdx

📚 Learning: 2025-10-11T19:12:38.832Z

Learnt from: osterman
Repo: cloudposse/atmos PR: 1599
File: tests/snapshots/TestCLICommands_atmos_workflow_invalid_step_type.stderr.golden:0-0
Timestamp: 2025-10-11T19:12:38.832Z
Learning: Usage Examples sections in error output are appropriate for command usage errors (incorrect syntax, missing arguments, invalid flags) but not for configuration validation errors (malformed workflow files, invalid settings in atmos.yaml). Configuration errors should focus on explaining what's wrong with the config, not command usage patterns.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2024-12-01T00:33:20.298Z

Learnt from: aknysh
Repo: cloudposse/atmos PR: 810
File: examples/tests/stacks/catalog/terraform/template-functions-test2/defaults.yaml:28-32
Timestamp: 2024-12-01T00:33:20.298Z
Learning: In `examples/tests/stacks/catalog/terraform/template-functions-test2/defaults.yaml`, `!exec atmos terraform output` is used in examples to demonstrate its usage, even though `!terraform.output` is the recommended approach according to the documentation.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2024-12-03T05:18:49.169Z

Learnt from: aknysh
Repo: cloudposse/atmos PR: 810
File: internal/exec/terraform_utils.go:40-213
Timestamp: 2024-12-03T05:18:49.169Z
Learning: In the context of the Atmos project, it's acceptable for functions like `execTerraformOutput` to remain as single functions if they perform a single purpose, such as retrieving Terraform outputs for a component in a stack, even if the function is lengthy.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2025-09-05T14:57:37.360Z

Learnt from: RoseSecurity
Repo: cloudposse/atmos PR: 1448
File: cmd/ansible.go:26-28
Timestamp: 2025-09-05T14:57:37.360Z
Learning: The Atmos codebase uses a consistent pattern for commands that delegate to external tools: `PersistentFlags().Bool("", false, doubleDashHint)` where doubleDashHint provides help text about using double dashes to separate Atmos options from native command arguments. This pattern is used across terraform, packer, helmfile, atlantis, aws, and ansible commands.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2025-09-07T17:38:40.486Z

Learnt from: osterman
Repo: cloudposse/atmos PR: 1466
File: website/src/components/Screengrabs/demo-stacks/deploy-staging.html:28-37
Timestamp: 2025-09-07T17:38:40.486Z
Learning: Files in website/src/components/Screengrabs/ directories are programmatically generated and should not be manually edited or reviewed for code suggestions.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2025-10-14T01:54:48.410Z

Learnt from: osterman
Repo: cloudposse/atmos PR: 1498
File: website/src/components/Screengrabs/atmos-completion--help.html:2-7
Timestamp: 2025-10-14T01:54:48.410Z
Learning: Screengrab HTML files in website/src/components/Screengrabs/ are generated from actual Atmos CLI output converted to HTML. The ANSI-art headers and formatting in these files are intentional and reflect the real CLI user experience, so they should not be suggested for removal or modification.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2025-01-09T22:27:25.538Z

Learnt from: samtholiya
Repo: cloudposse/atmos PR: 914
File: cmd/validate_stacks.go:20-23
Timestamp: 2025-01-09T22:27:25.538Z
Learning: The validate commands in Atmos can have different help handling implementations. Specifically, validate_component.go and validate_stacks.go are designed to handle help requests differently, with validate_stacks.go including positional argument checks while validate_component.go does not.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2025-09-27T20:50:20.564Z

Learnt from: osterman
Repo: cloudposse/atmos PR: 1533
File: pkg/config/load.go:585-637
Timestamp: 2025-09-27T20:50:20.564Z
Learning: In the cloudposse/atmos repository, command merging prioritizes precedence over display ordering. Help commands are displayed lexicographically regardless of internal array order, so the mergeCommandArrays function focuses on ensuring the correct precedence chain (top-level file wins) rather than maintaining specific display order.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2025-02-18T13:13:11.497Z

Learnt from: samtholiya
Repo: cloudposse/atmos PR: 1068
File: tests/snapshots/TestCLICommands_atmos_terraform_help.stdout.golden:59-64
Timestamp: 2025-02-18T13:13:11.497Z
Learning: For Atmos CLI help text, angle brackets in command examples and flag descriptions should be escaped using HTML entities (e.g., `&lt;component&gt;`) rather than converted to backticks or other markdown formatting.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2025-09-07T18:07:00.549Z

Learnt from: Benbentwo
Repo: cloudposse/atmos PR: 1452
File: cmd/auth_login.go:43-44
Timestamp: 2025-09-07T18:07:00.549Z
Learning: In the atmos project, the identity flag is defined as a persistent flag on the auth root command (cmd/auth.go), making it available to all auth subcommands without needing to be redefined in each individual subcommand.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2025-12-13T03:21:35.786Z

Learnt from: osterman
Repo: cloudposse/atmos PR: 1813
File: cmd/terraform/shell.go:28-73
Timestamp: 2025-12-13T03:21:35.786Z
Learning: In Atmos, when calling cfg.InitCliConfig, you must first populate the schema.ConfigAndStacksInfo struct with global flag values using flags.ParseGlobalFlags(cmd, v) rather than passing an empty struct. The LoadConfig function (pkg/config/load.go) reads config selection fields (AtmosConfigFilesFromArg, AtmosConfigDirsFromArg, BasePath, ProfilesFromArg) directly from the ConfigAndStacksInfo struct, NOT from Viper. Passing an empty struct causes config selection flags (--base-path, --config, --config-path, --profile) to be silently ignored. Correct pattern: parse flags → populate struct → call InitCliConfig. See cmd/terraform/plan_diff.go for reference implementation.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2024-12-03T05:29:07.718Z

Learnt from: aknysh
Repo: cloudposse/atmos PR: 810
File: internal/exec/terraform_utils.go:145-146
Timestamp: 2024-12-03T05:29:07.718Z
Learning: In the Atmos project, a 5-minute timeout in the `execTerraformOutput` function is acceptable for retrieving `terraform output` for a component in a stack.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2026-01-09T04:49:35.038Z

Learnt from: osterman
Repo: cloudposse/atmos PR: 1907
File: demos/fixtures/acme/stacks/catalog/api.yaml:1-29
Timestamp: 2026-01-09T04:49:35.038Z
Learning: In the cloudposse/atmos demos/fixtures, components can provide Terraform outputs via `remote_state_backend.static` configuration blocks instead of traditional Terraform output blocks. This pattern is used for demo/fixture purposes to simulate cross-component state references without deploying actual infrastructure. The `!terraform.state` YAML function reads from these static backends.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2025-03-18T12:26:25.329Z

Learnt from: Listener430
Repo: cloudposse/atmos PR: 1149
File: tests/snapshots/TestCLICommands_atmos_vendor_pull_ssh.stderr.golden:7-7
Timestamp: 2025-03-18T12:26:25.329Z
Learning: In the Atmos project, typos or inconsistencies in test snapshot files (such as "terrafrom" instead of "terraform") may be intentional as they capture the exact output of commands and should not be flagged as issues requiring correction.

Applied to files:

website/docs/cli/commands/terraform/usage.mdx

📚 Learning: 2024-12-03T04:01:16.446Z

Learnt from: aknysh
Repo: cloudposse/atmos PR: 810
File: website/docs/core-concepts/stacks/yaml-functions/terraform.output.mdx:0-0
Timestamp: 2024-12-03T04:01:16.446Z
Learning: In the `terraform.output.mdx` documentation file (`website/docs/core-concepts/stacks/yaml-functions/terraform.output.mdx`), the cache invalidation and cache scope behavior for the `!terraform.output` function are already described.

Applied to files:

website/docs/cli/commands/terraform/terraform-plan.mdx

🪛 LanguageTool

website/docs/cli/commands/terraform/terraform-deploy.mdx

[style] ~218-~218: This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional.
Context: ...cted Components Deploy only components affected by changes in the current branch (requi...

(EN_REPEATEDWORDS_AFFECT)

website/docs/cli/commands/terraform/terraform-apply.mdx

[style] ~347-~347: This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional.
Context: ...ected Components Apply only components affected by changes in the current branch (requi...

(EN_REPEATEDWORDS_AFFECT)

website/docs/cli/commands/terraform/terraform-plan.mdx

[grammar] ~313-~313: Use a hyphen to join words.
Context: ...ed --clone-target-ref=true ### Plan Specific Components shell # Plan spe...

(QB_NEW_EN_HYPHEN)

⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: Lint (golangci)
GitHub Check: Acceptance Tests (windows)
GitHub Check: Acceptance Tests (macos)
GitHub Check: Summary

🔇 Additional comments (6)

website/docs/cli/commands/terraform/terraform-deploy.mdx (1)

197-285: Well-structured Multi-Component Operations section.

The new section clearly documents the filtering flags (--all, --affected, --components, --query) with practical examples. The warning about auto-approval is appropriate given deploy's nature.

Good consistency with the parallel sections in terraform-plan.mdx and terraform-apply.mdx.

website/docs/cli/commands/terraform/terraform-apply.mdx (1)

326-414: Solid addition of Multi-Component Operations.

The section provides clear guidance on applying changes across multiple components. The warning about using --dry-run first is prudent advice.

website/docs/cli/commands/terraform/terraform-plan.mdx (1)

280-364: Consistent Multi-Component Operations documentation.

Good alignment with the sections in terraform-apply.mdx and terraform-deploy.mdx. The flags and examples follow the same structure, making it easy for users to find information regardless of which command page they land on.

website/docs/cli/commands/terraform/usage.mdx (3)

27-46: Clean introduction of Command Modes concept.

The two-mode framework (Single-Component vs Multi-Component) provides a clear mental model. The links to individual command pages for detailed options keep this overview concise.

76-92: Interactive selection behavior documented correctly.

Per the commit message fix, this correctly states that Atmos prompts for selection when multiple components match a path, rather than erroring. The CI/CD guidance to use explicit component names is practical.

119-119: Cross-reference intentionally excludes destroy.

The link to multi-component operations correctly omits terraform destroy, which aligns with the commit that removed --all and --affected support from destroy (it doesn't support multi-component operations).

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codecov · 2026-01-12T21:15:48Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.13%. Comparing base (0495d26) to head (30de6a0).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1952      +/-   ##
==========================================
+ Coverage   74.12%   74.13%   +0.01%     
==========================================
  Files         772      772              
  Lines       69744    69744              
==========================================
+ Hits        51695    51707      +12     
+ Misses      14618    14612       -6     
+ Partials     3431     3425       -6

Flag	Coverage Δ
unittests	`74.13% <ø> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 4 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

When multiple components match a path, Atmos prompts users to select in interactive terminals (not error). Only errors in CI/CD mode. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

coderabbitai · 2026-01-12T21:25:50Z

Caution

Review failed

The head commit changed during the review from 0ff6e1f to 5da4c24.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch osterman/terraform-usage-refactor

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2026-01-14T00:50:51Z

These changes were released in v1.204.0-rc.4.

osterman requested a review from a team as a code owner January 12, 2026 20:55

github-actions bot added the size/xl Extra large size PR label Jan 12, 2026

fix: remove incorrect multi-component docs from terraform destroy

0ff6e1f

The destroy command does not support --all or --affected flags. Only plan, apply, and deploy have these multi-component operations. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

github-actions bot deployed to preview January 12, 2026 20:59 View deployment

github-actions bot deployed to preview January 12, 2026 21:01 View deployment

fix: correct path resolution docs to show interactive selection

5da4c24

When multiple components match a path, Atmos prompts users to select in interactive terminals (not error). Only errors in CI/CD mode. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>

github-actions bot deployed to preview January 12, 2026 21:25 View deployment

osterman added the no-release Do not create a new release (wait for additional code changes) label Jan 12, 2026

coderabbitai bot approved these changes Jan 12, 2026

View reviewed changes

Merge branch 'main' into osterman/terraform-usage-refactor

30de6a0

github-actions bot deployed to preview January 13, 2026 14:32 View deployment

aknysh approved these changes Jan 13, 2026

View reviewed changes

aknysh merged commit b24edb5 into main Jan 13, 2026
57 checks passed

aknysh deleted the osterman/terraform-usage-refactor branch January 13, 2026 15:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: refactor terraform usage page#1952

docs: refactor terraform usage page#1952
aknysh merged 4 commits intomainfrom
osterman/terraform-usage-refactor

osterman commented Jan 12, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

mergify bot commented Jan 12, 2026

This PR exceeds the recommended limit of 1,000 lines.

Uh oh!

github-actions bot commented Jan 12, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Jan 12, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Uh oh!

codecov bot commented Jan 12, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Jan 12, 2026

Review failed

Uh oh!

Uh oh!

github-actions bot commented Jan 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

osterman commented Jan 12, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

what

why

references

Summary by CodeRabbit

Uh oh!

mergify bot commented Jan 12, 2026

This PR exceeds the recommended limit of 1,000 lines.

Uh oh!

github-actions bot commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dependency Review

Scanned Files

Uh oh!

coderabbitai bot commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Uh oh!

codecov bot commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

coderabbitai bot commented Jan 12, 2026

Review failed

Uh oh!

Uh oh!

github-actions bot commented Jan 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

osterman commented Jan 12, 2026 •

edited by coderabbitai bot

Loading

github-actions bot commented Jan 12, 2026 •

edited

Loading

coderabbitai bot commented Jan 12, 2026 •

edited

Loading

codecov bot commented Jan 12, 2026 •

edited

Loading