Rename add-ons to apps with deprecated backward compatibility (#627)

* Rename add-ons to apps with deprecated backward compatibility

Rename all occurrences of add-ons and its variations in commands and
flags to apps, with old commands/flags still available for backward
compatibility.

The Supervisor API still uses addons, so these occurrences are kept for
now, along with the related variables which process them. When/if this
API is changed, we can also rename these.

* Change --apps in backups to --app

* Improve grammer in backup descriptions

Also make first letters caps as it's more common across the repo.

* Fix previously present grammar issues highlighted in PR

* Fix the missed apps->app changes

Author: sairon

.github/ISSUE_TEMPLATE/bug_report.md

@@ -9,7 +9,7 @@ A clear and concise description of what the bug is.
 
 ## Debug information
 
-1. SSH Addon type
+1. SSH App type
 
 - [ ] Community
 - [ ] Core
@@ -18,8 +18,8 @@ A clear and concise description of what the bug is.
 2. Version of the CLI
 
 CLI Version: 
-Add-on: 
-Add-on version: 
+App:
+App version:
 
 3. Version of Home Assistant Core & the Home Assistant Supervisor
 

.github/copilot-instructions.md

@@ -3,7 +3,7 @@
 ## Project Overview
 This is the official Home Assistant CLI tool written in Go, providing command-line
 interface to interact with the Home Assistant Supervisor. The CLI enables users to
-manage add-ons, control the core system, handle audio/network settings, manage
+manage apps, control the core system, handle audio/network settings, manage
 backups, and perform various system operations.
 
 The CLI is communicating with the Supervisor using the Supervisor's HTTP REST API.
@@ -24,7 +24,7 @@ The CLI is communicating with the Supervisor using the Supervisor's HTTP REST AP
 
 ## Available Commands
 The CLI provides the following main command categories:
-- `addons` - Install, update, remove and configure Home Assistant add-ons
+- `apps` - Install, update, remove and configure Home Assistant apps
 - `audio` - Audio plug-in management
 - `authentication` - Authentication for Home Assistant users
 - `cli` - CLI plug-in management
@@ -78,4 +78,4 @@ The CLI provides the following main command categories:
 6. Create Pull Request
 
 This CLI is designed to work with Home Assistant Supervisor API and is commonly used in
-Home Assistant Operating System environments, SSH add-ons, and development setups.
+Home Assistant Operating System environments, SSH apps, and development setups.

README.md

@@ -32,7 +32,7 @@ All options are also available as `SUPERVISOR_` prefixed environment variables l
 Available commands:
 
 ```text
-  addons         Install, update, remove and configure Home Assistant add-ons
+  apps           Install, update, remove and configure Home Assistant apps
   audio          Audio device handling.
   authentication Authentication for Home Assistant users.
   cli            Get information, update or configure the Home Assistant cli backend
@@ -59,19 +59,19 @@ available on the device terminal when using the Home Assistant Operating System.
 
 The CLI is automatically updated on those systems.
 
-Furthermore, the SSH add-on (available in the add-on store) provides
-access to this tool and several community add-ons provide it as well (e.g.,
-the Visual Studio Code add-on).
+Furthermore, the SSH app (available in the app store) provides
+access to this tool and several community apps provide it as well (e.g.,
+the Visual Studio Code app).
 
 ## Developing & contributing
 
 ### Prerequisites
 
 The CLI can interact remotely with the Home Assistant Supervisor using the
-`remote_api` add-on from the [developer add-ons repository](https://github.com/home-assistant/addons-development).
+`remote_api` app from the [developer app repository](https://github.com/home-assistant/addons-development).
 
-After installing and starting the add-on, a token is shown in the `remote_api`
-add-on log, which is needed for further development.
+After installing and starting the app, a token is shown in the `remote_api`
+app log, which is needed for further development.
 
 ### Get the source code
 
@@ -86,7 +86,7 @@ go run main.go info
 ```
 
 **Note**: Replace the `192.168.1.2` with the IP address of your Home Assistant
-instance running the `remote_api` add-on and use the token provided.
+instance running the `remote_api` app and use the token provided.
 
 ### Building
 

cmd/addons.go cmd/apps.gocmd/addons.go renamed to cmd/apps.go

@@ -1,27 +1,36 @@
 package cmd
 
 import (
+	"os"
 	"strings"
 
 	helper "github.com/home-assistant/cli/client"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
-var addonsCmd = &cobra.Command{
-	Use:     "addons",
-	Aliases: []string{"addon", "add-on", "add-ons", "ad"},
-	Short:   "Install, update, remove and configure Home Assistant add-ons",
+var appsCmd = &cobra.Command{
+	Use:     "apps",
+	Aliases: []string{"app", "addons", "addon", "add-on", "add-ons", "ad"},
+	Short:   "Install, update, remove and configure Home Assistant apps",
 	Long: `
-The addons command allows you to manage Home Assistant add-ons 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 add-ons.`,
+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`,
+	PersistentPreRun: func(cmd *cobra.Command, args []string) {
+		for idx, arg := range os.Args {
+			if idx != 0 && (arg == "addons" || arg == "addon" || arg == "add-on" || arg == "add-ons" || arg == "ad") {
+				cmd.PrintErrf("The use of '%s' is deprecated, please use 'apps' instead!\n", arg)
+			}
+		}
+		rootCmd.PersistentPreRun(cmd, args)
+	},
 	Run: func(cmd *cobra.Command, args []string) {
-		log.WithField("args", args).Debug("addons")
+		log.WithField("args", args).Debug("apps")
 
 		section := "addons"
 		command := ""
@@ -37,12 +46,12 @@ information commands for add-ons.`,
 }
 
 func init() {
-	log.Debug("Init addons")
+	log.Debug("Init apps")
 
-	rootCmd.AddCommand(addonsCmd)
+	rootCmd.AddCommand(appsCmd)
 }
 
-func addonsCompletions(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+func appsCompletions(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 	if len(args) != 0 {
 		return nil, cobra.ShellCompDirectiveNoFileComp
 	}

cmd/addons_changelog.go cmd/apps_changelog.gocmd/addons_changelog.go renamed to cmd/apps_changelog.go

@@ -9,20 +9,20 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var addonsChangelogCmd = &cobra.Command{
+var appsChangelogCmd = &cobra.Command{
 	Use:     "changelog [slug]",
 	Aliases: []string{"cl", "ch"},
-	Short:   "Show changelog of a Home Assistant add-on",
+	Short:   "Show changelog of a Home Assistant app",
 	Long: `
-This command shows the changelog of an add-on. It gives you what has been
+This command shows the changelog of an app. It gives you what has been
 changed in the latest version and tell you about possible breaking changes.`,
 	Example: `
-ha addons changelog core_ssh
-ha addons changelog core_mosquitto`,
-	ValidArgsFunction: addonsCompletions,
+ha apps changelog core_ssh
+ha apps changelog core_mosquitto`,
+	ValidArgsFunction: appsCompletions,
 	Args:              cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		log.WithField("args", args).Debug("addons changelog")
+		log.WithField("args", args).Debug("apps changelog")
 
 		section := "addons"
 		command := "{slug}/changelog"
@@ -61,5 +61,5 @@ ha addons changelog core_mosquitto`,
 }
 
 func init() {
-	addonsCmd.AddCommand(addonsChangelogCmd)
+	appsCmd.AddCommand(appsChangelogCmd)
 }

cmd/addons_info.go cmd/apps_info.gocmd/addons_info.go renamed to cmd/apps_info.go

@@ -6,22 +6,22 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var addonsInfoCmd = &cobra.Command{
+var appsInfoCmd = &cobra.Command{
 	Use:     "info [slug]",
 	Aliases: []string{"in", "info"},
-	Short:   "Show information about available Home Assistant add-ons",
+	Short:   "Show information about available Home Assistant apps",
 	Long: `
-This command can provide information on all available add-ons or, if a slug
-is provided, information about a specific add-on.
+This command can provide information on all available apps or, if a slug
+is provided, information about a specific app.
 `,
 	Example: `
-  ha addons info
-  ha addons info core_ssh
+  ha apps info
+  ha apps info core_ssh
 `,
-	ValidArgsFunction: addonsCompletions,
+	ValidArgsFunction: appsCompletions,
 	Args:              cobra.MaximumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		log.WithField("args", args).Debug("addons info")
+		log.WithField("args", args).Debug("apps info")
 
 		section := "addons"
 		command := "{slug}/info"
@@ -58,5 +58,5 @@ is provided, information about a specific add-on.
 }
 
 func init() {
-	addonsCmd.AddCommand(addonsInfoCmd)
+	appsCmd.AddCommand(appsInfoCmd)
 }

cmd/addons_install.go cmd/apps_install.gocmd/addons_install.go renamed to cmd/apps_install.go

@@ -6,20 +6,20 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var addonsInstalCmd = &cobra.Command{
+var appsInstallCmd = &cobra.Command{
 	Use:     "install [slug]",
 	Aliases: []string{"i", "inst"},
-	Short:   "Installs a Home Assistant add-on",
+	Short:   "Installs a Home Assistant app",
 	Long: `
-This command allows you to install a Home Assistant add-on from the commandline.
+This command allows you to install a Home Assistant app from the commandline.
 `,
 	Example: `
-  ha addons install core_ssh
+  ha apps install core_ssh
 `,
-	ValidArgsFunction: storeAddonCompletions,
+	ValidArgsFunction: storeAppCompletions,
 	Args:              cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		log.WithField("args", args).Debug("addons install")
+		log.WithField("args", args).Debug("apps install")
 
 		section := "addons"
 		command := "{slug}/install"
@@ -56,5 +56,5 @@ This command allows you to install a Home Assistant add-on from the commandline.
 
 func init() {
 
-	addonsCmd.AddCommand(addonsInstalCmd)
+	appsCmd.AddCommand(appsInstallCmd)
 }

cmd/addons_logs.go cmd/apps_logs.gocmd/addons_logs.go renamed to cmd/apps_logs.go

@@ -6,20 +6,20 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var addonsLogsCmd = &cobra.Command{
+var appsLogsCmd = &cobra.Command{
 	Use:     "logs [slug]",
 	Aliases: []string{"log", "lg"},
-	Short:   "View the log output of a running Home Assistant add-on",
+	Short:   "View the log output of a running Home Assistant app",
 	Long: `
-Allowing you to look at the log output generated by a Home Assistant add-on.
+Allowing you to look at the log output generated by a Home Assistant app.
 `,
 	Example: `
-  ha addons logs core_ssh
+  ha apps logs core_ssh
 `,
-	ValidArgsFunction: addonsCompletions,
+	ValidArgsFunction: appsCompletions,
 	Args:              cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		log.WithField("args", args).Debug("addons logs")
+		log.WithField("args", args).Debug("apps logs")
 
 		section := "addons/{slug}"
 
@@ -47,7 +47,7 @@ Allowing you to look at the log output generated by a Home Assistant add-on.
 }
 
 func init() {
-	addLogsFlags(addonsLogsCmd)
+	addLogsFlags(appsLogsCmd)
 
-	addonsCmd.AddCommand(addonsLogsCmd)
+	appsCmd.AddCommand(appsLogsCmd)
 }

cmd/addons_rebuild.go cmd/apps_rebuild.gocmd/addons_rebuild.go renamed to cmd/apps_rebuild.go

@@ -6,26 +6,25 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var addonsRebuildForce bool
+var appsRebuildForce bool
 
-var addonsRebuildCmd = &cobra.Command{
+var appsRebuildCmd = &cobra.Command{
 	Use:     "rebuild [slug]",
 	Aliases: []string{"rb", "reinstall"},
-	Short:   "Rebuild a locally built Home Assistant add-on",
+	Short:   "Rebuild a locally built Home Assistant app",
 	Long: `
-Most add-ons provide pre-built images Home Assistant can download and use.
+Most apps provide pre-built images Home Assistant can download and use.
 However, some don't. This is usually the case for local or development version
-of add-ons. This command allows you to trigger a rebuild of a locally built
-add-on.
+of apps. This command allows you to trigger a rebuild of a locally built app.
 `,
 	Example: `
-  ha addons rebuild local_my_addon
-  ha addons rebuild local_my_addon --force
+  ha apps rebuild local_my_app
+  ha apps rebuild local_my_app --force
 `,
-	ValidArgsFunction: addonsCompletions,
+	ValidArgsFunction: appsCompletions,
 	Args:              cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		log.WithField("args", args).Debug("addons rebuild")
+		log.WithField("args", args).Debug("apps rebuild")
 
 		section := "addons"
 		command := "{slug}/rebuild"
@@ -45,7 +44,7 @@ add-on.
 			"slug": slug,
 		})
 
-		if addonsRebuildForce {
+		if appsRebuildForce {
 			request.SetBody(map[string]interface{}{
 				"force": true,
 			})
@@ -67,6 +66,6 @@ add-on.
 }
 
 func init() {
-	addonsRebuildCmd.Flags().BoolVar(&addonsRebuildForce, "force", false, "Force rebuild of the add-on even if pre-built images are provided")
-	addonsCmd.AddCommand(addonsRebuildCmd)
+	appsRebuildCmd.Flags().BoolVar(&appsRebuildForce, "force", false, "Force rebuild of the app even if pre-built images are provided")
+	appsCmd.AddCommand(appsRebuildCmd)
 }

cmd/addons_restart.go cmd/apps_restart.gocmd/addons_restart.go renamed to cmd/apps_restart.go

@@ -6,20 +6,20 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var addonsRestartCmd = &cobra.Command{
+var appsRestartCmd = &cobra.Command{
 	Use:     "restart [slug]",
 	Aliases: []string{"reboot"},
-	Short:   "Restarts a Home Assistant add-on",
+	Short:   "Restarts a Home Assistant app",
 	Long: `
-Restart a Home Assistant add-on
+Restart a Home Assistant app
 `,
 	Example: `
-  ha addons restart core_ssh
+  ha apps restart core_ssh
 `,
-	ValidArgsFunction: addonsCompletions,
+	ValidArgsFunction: appsCompletions,
 	Args:              cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		log.WithField("args", args).Debug("addons restart")
+		log.WithField("args", args).Debug("apps restart")
 
 		section := "addons"
 		command := "{slug}/restart"
@@ -53,5 +53,5 @@ Restart a Home Assistant add-on
 
 func init() {
 
-	addonsCmd.AddCommand(addonsRestartCmd)
+	appsCmd.AddCommand(appsRestartCmd)
 }