Skip to content

Conversation

@AJediIAm
Copy link

@AJediIAm AJediIAm commented Feb 1, 2026

Summary by CodeRabbit

  • Chores
    • Updated help documentation with improved terminology for the apps command.
    • Added convenient alternative command aliases for easier access.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 1, 2026

📝 Walkthrough

Walkthrough

Updated the addons command to use "apps" terminology instead of "addons" throughout its description and added "app" and "apps" to the command aliases. Changes are limited to documentation and alias configuration without functional modifications.

Changes

Cohort / File(s) Summary
Command terminology and aliases
cmd/addons.go
Extended command aliases by adding "app" and "apps" to the list. Updated command description from "addons" to "apps" in both the short description and long description text.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 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 accurately describes the main change: adding 'app' aliases to the addons command, which aligns with the file modifications in cmd/addons.go.
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 docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@cmd/addons.go`:
- Around line 14-18: The help text mixes "apps" and "addons" which is
inconsistent; update the Short and Long description in cmd/addons.go and the
examples that follow to consistently use the "add-ons" terminology (or
consistently "addons"/"add-ons" spelling) so they match the command name
`addons`, e.g., change occurrences of "apps" to "add-ons" and update example
usage strings (the example lines following the Long text) to show `ha addons
...`; ensure the sentence in Long references the same term ("The addons command
allows you to manage Home Assistant add-ons") and keep grammar (install, remove,
configure and control) consistent.

Comment on lines +14 to +18
Short: "Install, update, remove and configure Home Assistant apps",
Long: `
The addons command allows you to manage Home Assistant add-ons by exposing
The addons command allows you to manage Home Assistant apps by exposing
commands for installing, removing, configure and control them. It also provides
information commands for add-ons.`,
information commands for apps.`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Inconsistent terminology between help text and command usage.

The help text now refers to "apps" throughout, but the examples (lines 20-22) still demonstrate ha addons command usage. This creates confusion for users who read about "apps" but must type "addons".

Additionally, line 16 states "The addons command allows you to manage Home Assistant apps," mixing both terminologies in a single sentence.

Consider one of the following approaches:

  • Option 1: Update the examples to use the new app or apps aliases (e.g., ha apps logs core_ssh)
  • Option 2: Keep the original "add-ons" terminology in descriptions and maintain consistency with the command name
📝 Option 1: Update to consistently use "apps" terminology
 	Long: `
-The addons command allows you to manage Home Assistant apps by exposing
+The apps command allows you to manage Home Assistant apps by exposing
 commands for installing, removing, configure and control them. It also provides
 information commands for apps.`,
 	Example: `
-  ha addons logs core_ssh
-  ha addons install core_ssh
-  ha addons start core_ssh`,
+  ha apps logs core_ssh
+  ha apps install core_ssh
+  ha apps start core_ssh`,

Option 2: Revert to consistent "add-ons" terminology (if "apps" transition isn't complete):

-	Short:   "Install, update, remove and configure Home Assistant apps",
+	Short:   "Install, update, remove and configure Home Assistant add-ons",
 	Long: `
-The addons command allows you to manage Home Assistant apps by exposing
+The addons command allows you to manage Home Assistant add-ons by exposing
 commands for installing, removing, configure and control them. It also provides
-information commands for apps.`,
+information commands for add-ons.`,
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Short: "Install, update, remove and configure Home Assistant apps",
Long: `
The addons command allows you to manage Home Assistant add-ons by exposing
The addons command allows you to manage Home Assistant apps by exposing
commands for installing, removing, configure and control them. It also provides
information commands for add-ons.`,
information commands for apps.`,
Short: "Install, update, remove and configure Home Assistant add-ons",
Long: `
The addons command allows you to manage Home Assistant add-ons by exposing
commands for installing, removing, configure and control them. It also provides
information commands for add-ons.`,
🤖 Prompt for AI Agents
In `@cmd/addons.go` around lines 14 - 18, The help text mixes "apps" and "addons"
which is inconsistent; update the Short and Long description in cmd/addons.go
and the examples that follow to consistently use the "add-ons" terminology (or
consistently "addons"/"add-ons" spelling) so they match the command name
`addons`, e.g., change occurrences of "apps" to "add-ons" and update example
usage strings (the example lines following the Long text) to show `ha addons
...`; ensure the sentence in Long references the same term ("The addons command
allows you to manage Home Assistant add-ons") and keep grammar (install, remove,
configure and control) consistent.

Copy link
Member

@sairon sairon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is already handled more extensively by #627.

@sairon sairon closed this Feb 2, 2026
@AJediIAm AJediIAm deleted the patch-1 branch February 2, 2026 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants