Updated help messages

functional/core/core_feature.json

@@ -63,7 +63,7 @@
                 "action":"main"
             }
         ],
-        "result":"It can be used to add formulas, repositories and other objects.."
+        "result":"Add a new formula repository to ritchie-cli."
     },
     {
         "entry":"Add new repo",
@@ -158,7 +158,7 @@
                 "action":"main"
             }
         ],
-        "result":"Set objects like credentials, etc."
+        "result":"Set contexts, credentials and priorities for formula repositories."
     },
     {
         "entry":"Update repo",
@@ -180,7 +180,7 @@
                 "action":"main"
             }
         ],
-        "result":"Add autocomplete for terminal, Available for (bash, zsh)."
+        "result":"Add autocomplete for terminal, available for (zsh, bash, fish, powershell)."
     },
     {
         "entry":"Completion bash",
@@ -224,7 +224,7 @@
                 "action":"main"
             }
         ],
-        "result":"Delete objects like users, etc."
+        "result":"Delete a object like context and repository."
     },
     {
         "entry":"Show",
@@ -235,7 +235,7 @@
                 "action":"main"
             }
         ],
-        "result":"Show objects like context, organization etc."
+        "result":"Show current context."
     },
     {
         "entry":"Help",

pkg/cmd/add.go

@@ -4,17 +4,12 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var descAddLong = `
-This command consists of multiple subcommands to interact with ritchie.
-
-It can be used to add formulas, repositories and other objects..
-`
-
 // NewAddCmd create a new add instance
 func NewAddCmd() *cobra.Command {
 	return &cobra.Command{
-		Use:   "add SUBCOMMAND",
-		Short: "add objects",
-		Long:  descAddLong,
+		Use:     "add SUBCOMMAND",
+		Short:   "Add repositories ",
+		Long:    "Add a new formula repository to ritchie-cli.",
+		Example: "rit add repo",
 	}
 }

pkg/cmd/add_repo.go

@@ -55,8 +55,8 @@ func NewAddRepoCmd(
 	}
 	cmd := &cobra.Command{
 		Use:     "repo",
-		Short:   "Add a repository.",
-		Example: "rit add repo ",
+		Short:   "Add a repository",
+		Example: "rit add repo",
 		RunE:    RunFuncE(addRepo.runStdin(), addRepo.runPrompt()),
 	}
 	cmd.LocalFlags()

pkg/cmd/autocomplete.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/spf13/cobra"
 
@@ -15,17 +16,21 @@ const (
 	powerShell autocomplete.ShellName = "powershell"
 )
 
+var supportedShell = []string{zsh.String(), bash.String(), fish.String(), powerShell.String()}
+
 // autocompleteCmd type for set autocomplete command
 type autocompleteCmd struct {
 	autocomplete.Generator
 }
 
 // NewAutocompleteCmd creates a new cmd instance
 func NewAutocompleteCmd() *cobra.Command {
+	shells := strings.Join(supportedShell, ", ")
+
 	return &cobra.Command{
 		Use:     "completion SUBCOMMAND",
-		Short:   "Add autocomplete for terminal",
-		Long:    `Add autocomplete for terminal, Available for (bash, zsh).`,
+		Short:   "Add autocomplete for terminal (" + shells + ")",
+		Long:    "Add autocomplete for terminal, available for (" + shells + ").",
 		Example: "rit completion zsh",
 	}
 }

pkg/cmd/build.go

@@ -4,8 +4,9 @@ import "github.com/spf13/cobra"
 
 func NewBuildCmd() *cobra.Command {
 	return &cobra.Command{
-		Use:   "build SUB_COMMAND",
-		Short: "This is a root command, needs a sub command",
-		Long:  `This is a root command, to use it, add a sub command. For example, rit build formula.`,
+		Use:     "build SUB_COMMAND",
+		Short:   "Build formulas - with subcomando formulas",
+		Long:    "This is a root command, to use it, add a sub command.",
+		Example: "rit build formula",
 	}
-}
+}

pkg/cmd/create.go

@@ -7,8 +7,9 @@ import (
 // NewCreateCmd creates new cmd instance
 func NewCreateCmd() *cobra.Command {
 	return &cobra.Command{
-		Use:   "create SUBCOMMAND",
-		Short: "Create objects",
-		Long:  `Create objects like users, etc.`,
+		Use:     "create SUBCOMMAND",
+		Short:   "Create formulas",
+		Long:    "Create a new formula.",
+		Example: "rit create formula",
 	}
 }

pkg/cmd/delete.go

@@ -5,8 +5,9 @@ import "github.com/spf13/cobra"
 // NewDeleteCmd create a new delete instance
 func NewDeleteCmd() *cobra.Command {
 	return &cobra.Command{
-		Use:   "delete SUBCOMMAND",
-		Short: "Delete objects",
-		Long:  `Delete objects like users, etc.`,
+		Use:     "delete SUBCOMMAND",
+		Short:   "Delete objects (contexts, repositories)",
+		Long:    "Delete a object like context and repository.",
+		Example: "rit delete context",
 	}
 }

pkg/cmd/delete_context.go

@@ -31,9 +31,9 @@ func NewDeleteContextCmd(
 
 	cmd := &cobra.Command{
 		Use:     "context",
-		Short:   "Delete context for Ritchie-cli",
+		Short:   "Delete context for ritchie-cli",
 		Example: "rit delete context",
-		RunE: RunFuncE(d.runStdin(), d.runPrompt()),
+		RunE:    RunFuncE(d.runStdin(), d.runPrompt()),
 	}
 
 	cmd.LocalFlags()

pkg/cmd/init.go

@@ -34,7 +34,7 @@ func NewInitCmd(repo formula.RepositoryAdder, git github.Repositories) *cobra.Co
 
 	cmd := &cobra.Command{
 		Use:   "init",
-		Short: "Init rit",
+		Short: "Initialize rit configuration",
 		Long:  "Initialize rit configuration",
 		RunE:  o.runPrompt(),
 	}

pkg/cmd/list.go

@@ -11,8 +11,9 @@ It can be used to list formulas, repositories and other objects.
 // NewListCmd create a new list instance
 func NewListCmd() *cobra.Command {
 	return &cobra.Command{
-		Use:   "list SUBCOMMAND",
-		Short: "list objects ",
-		Long:  descListLong,
+		Use:     "list SUBCOMMAND",
+		Short:   "List repositories",
+		Long:    "List all formula repositories.",
+		Example: "rit list repo",
 	}
 }

pkg/cmd/set.go

@@ -7,8 +7,9 @@ import (
 // NewSetCmd creates new cmd instance
 func NewSetCmd() *cobra.Command {
 	return &cobra.Command{
-		Use:   "set SUBCOMMAND",
-		Short: "Set objects",
-		Long:  `Set objects like credentials, etc.`,
+		Use:     "set SUBCOMMAND",
+		Short:   "Set objects (context, credential, repo-priority)",
+		Long:    "Set contexts, credentials and priorities for formula repositories.",
+		Example: "rit set context",
 	}
 }

pkg/cmd/show.go

@@ -4,8 +4,9 @@ import "github.com/spf13/cobra"
 
 func NewShowCmd() *cobra.Command {
 	return &cobra.Command{
-		Use:   "show SUB_COMMAND",
-		Short: "Show objects",
-		Long:  `Show objects like context, organization etc.`,
+		Use:     "show SUB_COMMAND",
+		Short:   "Show context",
+		Long:    "Show current context.",
+		Example: "rit show context",
 	}
 }

pkg/cmd/update.go

@@ -2,17 +2,12 @@ package cmd
 
 import "github.com/spf13/cobra"
 
-var descUpdateLong = `
-This command consists of multiple subcommands to interact with ritchie.
-
-It can be used to update formulas repositories and etc.
-`
-
 // NewUpdateCmd create a new update instance
 func NewUpdateCmd() *cobra.Command {
 	return &cobra.Command{
-		Use:   "update SUBCOMMAND",
-		Short: "update objects",
-		Long:  descUpdateLong,
+		Use:     "update SUBCOMMAND",
+		Short:   "Update repositories",
+		Long:    "Update repositories.",
+		Example: "rit update repo",
 	}
 }