Display CLI config aliases in separate ALIASES help section

[osterman]

what

• CLI aliases defined in atmos.yaml now appear in a dedicated "ALIASES" section in --help output
• Separates user-defined command shortcuts from regular commands for improved help clarity
• Maintains distinction between built-in command aliases and CLI config aliases

why

Users reported that aliases added via CLI config (atmos.yaml) appeared mixed with regular commands in the "AVAILABLE COMMANDS" section, making help output less clear. Creating a dedicated "ALIASES" section improves UX by clearly distinguishing shortcuts from actual commands.

implementation

• Mark config aliases with "configAlias" annotation in processCommandAliases()
• Add isConfigAlias() helper to identify config alias commands
• Filter config aliases from printAvailableCommands() and calculateMaxCommandWidth()
• Add printConfigAliases() function to render aliases in dedicated section
• Comprehensive unit tests for new functionality

Summary by CodeRabbit

• New Features

  • Help output now shows configuration aliases in a dedicated "ALIASES" section for clearer discovery.
  • Alias commands are marked as config aliases and run as direct subprocesses, preserving their original exit status.
  • Help snapshots now include a telemetry notice banner with opt-out info.

• Bug Fixes

  • Improved alias execution to reliably surface underlying command exit codes.

• Tests

  • Added tests and updated snapshots to validate alias handling and help rendering.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds annotation-based config alias support and switches alias execution to direct os/exec invocation; config aliases are excluded from normal command listings and rendered in a new ALIASES help section. Tests and golden snapshots updated to cover the new help output and telemetry banner.

Changes

Cohort / File(s)	Summary
Alias execution & annotation cmd/cmd_utils.go	Alias commands now receive an Annotations["configAlias"] entry and execute by invoking the current executable via os/exec with built args/env; preserves subprocess exit codes and retains existing error handling.
Help rendering for config aliases cmd/help_template.go	Adds isConfigAlias, getConfigAliases, and printConfigAliases; excludes config aliases from normal width calculation/listing and renders them in a separate ALIASES section integrated into help output.
Help tests cmd/help_template_test.go, cmd/cmd_utils_test.go	Adds unit tests: TestPrintConfigAliases, TestIsConfigAlias, and multiple processCommandAliases tests validating alias creation, annotations, and non-top-level behavior.
Golden snapshots tests/snapshots/...TestCLICommands_atmos_--help_config_aliases_section.*, tests/snapshots/...config_alias_tp_--help_shows_terraform_plan_help.*, tests/snapshots/...config_alias_tr_--help_shows_terraform_help.*	Adds/updates stdout and stderr golden files for help output including the new ALIASES section and a telemetry notice banner.
Help/usage test cases tests/test-cases/help-and-usage.yaml	Adds three (duplicated later to six) help-and-usage test cases covering atmos --help config aliases and config alias tp/tr help invocations.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

• Pay attention to: cmd/cmd_utils.go alias execution path (arg/env filtering, working dir, stdio wiring, exit-code preservation).
• Validate cmd/help_template.go integration for width calculations, ordering, Markdown rendering, and that non-alias commands are unaffected.
• Review new unit tests and golden snapshots for correctness and potential flakiness; check duplicated test-case entries in tests/test-cases/help-and-usage.yaml.

Suggested labels

minor

Suggested reviewers

• osterman

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 77.78% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: introducing a separate ALIASES section in help output to display CLI config aliases, which is the primary focus across multiple modified files.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch osterman/cli-alias-help-display

---

📜 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 a3d852e and 917d4e5.

📒 Files selected for processing (1)

• cmd/cmd_utils_test.go (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• cmd/cmd_utils_test.go

⏰ 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). (2)

• GitHub Check: Acceptance Tests (windows)
• GitHub Check: Summary

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

[codecov]

Codecov Report

❌ Patch coverage is 68.08511% with 15 lines in your changes missing coverage. Please review.
✅ Project coverage is 73.33%. Comparing base (93d2e6b) to head (917d4e5).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/cmd_utils.go	17.64%	14 Missing ⚠️
cmd/help_template.go	96.66%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1867   +/-   ##
=======================================
  Coverage   73.33%   73.33%           
=======================================
  Files         563      563           
  Lines       54217    54258   +41     
=======================================
+ Hits        39760    39792   +32     
- Misses      11601    11612   +11     
+ Partials     2856     2854    -2     

Flag	Coverage Δ
unittests	73.33% <68.08%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
cmd/help_template.go	77.32% <96.66%> (+1.58%)	⬆️
cmd/cmd_utils.go	55.69% <17.64%> (-0.68%)	⬇️

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:

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

[mergify]

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]

These changes were released in v1.202.0-rc.1.

[github-actions]

These changes were released in v1.203.0-test.1.