cmd: Change help messages according to @garethr's suggestions.

Signed-off-by: Matthieu Nottale <[email protected]>

Author: Matthieu Nottale

cmd/deploy.go

@@ -13,11 +13,9 @@ import (
 // deployCmd represents the deploy command
 var deployCmd = &cobra.Command{
 	Use:   "deploy [<app-name>]",
-	Short: "Deploy the specified app on the connected cluster",
-	Long: `Deploy the application on either swarm or kubernetes.
-The app's docker-compose.yml is first rendered as per the render sub-command, and
-then deployed similarly to 'docker stack deploy'.`,
-	Args: cli.RequiresMaxArgs(1),
+	Short: "Deploy or update an application",
+	Long:  `Deploy the application on either Swarm or Kubernetes.`,
+	Args:  cli.RequiresMaxArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		if do, ok := os.LookupEnv("DOCKER_ORCHESTRATOR"); ok {
 			deployOrchestrator = do

cmd/helm.go

@@ -9,14 +9,9 @@ import (
 
 var helmCmd = &cobra.Command{
 	Use:   "helm [<app-name>] [-s key=value...] [-f settings-file...]",
-	Short: "Render the Compose file for this app as an Helm package",
-	Long: `The helm command creates or updates the directory <app-name>.chart.
-- Chart.yaml is created or updated from the app's metadata.
-- values.yaml is created or updated with the values from settings which are
-  actually used by the compose file.
-- templates/stack.yaml is created, with a stack template extracted from the app's
-docker-compose.yml.`,
-	Args: cli.RequiresMaxArgs(1),
+	Short: "Generate a Helm chart",
+	Long:  `Generate a Helm chart for the application.`,
+	Args:  cli.RequiresMaxArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		d, err := parseSettings(helmEnv)
 		if err != nil {

cmd/init.go

@@ -9,11 +9,9 @@ import (
 // initCmd represents the init command
 var initCmd = &cobra.Command{
 	Use:   "init <app-name> [-c <compose-file>] [-d <description>] [-m name:email ...]",
-	Short: "Initialize an app package in the current working directory",
-	Long: `This command initializes a new app package. If the -c option is used, or
-if a file named docker-compose.yml is found in the current directory, this file
-and the associated .env file if found will be used as the base for this application.`,
-	Args: cli.ExactArgs(1),
+	Short: "Start building a Docker application",
+	Long:  `Start building a Docker application. Will automatically detect a docker-compose.yml file in the current directory.`,
+	Args:  cli.ExactArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return packager.Init(args[0], initComposeFile, initDescription, initMaintainers)
 	},

cmd/inspect.go

@@ -9,7 +9,7 @@ import (
 // inspectCmd represents the inspect command
 var inspectCmd = &cobra.Command{
 	Use:   "inspect [<app-name>]",
-	Short: "Shows metadata and settings for a given app package",
+	Short: "Shows metadata and settings for a given application",
 	Args:  cli.RequiresMaxArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		return renderer.Inspect(firstOrEmpty(args))

cmd/render.go

@@ -13,15 +13,9 @@ import (
 
 var renderCmd = &cobra.Command{
 	Use:   "render <app-name> [-s key=value...] [-f settings-file...]",
-	Short: "Render the Compose file for this app",
-	Long: `Render generates a Compose file from the application's template and optional additional files.
-Override is provided in different ways:
-- External YAML settings files can be specified with the -f flag. All settings
-  files are merged in order, the app's settings coming first.
-- Individual settings values can be passed directly on the command line with the
-  -s flag. These value takes precedence over all settings files.
-`,
-	Args: cli.RequiresMaxArgs(1),
+	Short: "Render the Compose file for the application",
+	Long:  `Render the Compose file for the application.`,
+	Args:  cli.RequiresMaxArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
 		d, err := parseSettings(renderEnv)
 		if err != nil {

cmd/root.go

@@ -12,12 +12,9 @@ import (
 
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
-	Use:   "docker-app",
-	Short: "Docker App Packages",
-	Long: `Create, render deploy and otherwise manipulate an app package.
-For most sub-commands that take an app-package as only positional argument, this
-argument is optional: an app package is looked for in the current working directory.
-All commands accept both compressed and uncompressed app packages.`,
+	Use:          "docker-app",
+	Short:        "Docker App Packages",
+	Long:         `Build and deploy Docker applications.`,
 	SilenceUsage: true,
 	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 		if internal.Debug {