feat: group commands into user vs internal vs additional

Signed-off-by: Nick Mitchell <[email protected]>
aavarghese · Sep 26, 2024 · ef34ca5 · ef34ca5
1 parent 1a3cc57
commit ef34ca5
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 28 deletions.
diff --git a/cmd/subcommands/build.go b/cmd/subcommands/build.go
@@ -18,10 +18,11 @@ func newBuildCmd() *cobra.Command {
 	var allFlag bool
 
 	cmd := &cobra.Command{
-		Use:   "build [path-or-git]",
-		Short: "Generate a binary specialized to a given application",
-		Long:  "Generate a binary specialized to a given application",
-		Args:  cobra.MatchAll(cobra.MaximumNArgs(1), cobra.OnlyValidArgs),
+		Use:     "build [path-or-git]",
+		GroupID: applicationGroup.ID,
+		Short:   "Generate a binary specialized to a given application",
+		Long:    "Generate a binary specialized to a given application",
+		Args:    cobra.MatchAll(cobra.MaximumNArgs(1), cobra.OnlyValidArgs),
 	}
 
 	cmd.Flags().StringVarP(&outputFlag, "output", "o", "", "Path to store output binary")

diff --git a/cmd/subcommands/component.go b/cmd/subcommands/component.go
@@ -8,8 +8,9 @@ import (
 
 func init() {
 	cmd := &cobra.Command{
-		Use:   "component",
-		Short: "Commands related to specific components",
+		Use:     "component",
+		GroupID: internalGroup.ID,
+		Short:   "Commands related to specific components",
 	}
 	rootCmd.AddCommand(cmd)
 

diff --git a/cmd/subcommands/dev.go b/cmd/subcommands/dev.go
@@ -10,9 +10,10 @@ import (
 
 func init() {
 	var cmd = &cobra.Command{
-		Use:   "dev",
-		Short: "Commands related to local Lunchpail development",
-		Long:  "Commands related to local Lunchpail development",
+		Use:     "dev",
+		GroupID: internalGroup.ID,
+		Short:   "Commands related to local Lunchpail development",
+		Long:    "Commands related to local Lunchpail development",
 	}
 
 	cmd.AddCommand(dev.Init())

diff --git a/cmd/subcommands/down.go b/cmd/subcommands/down.go
@@ -20,9 +20,10 @@ func newDownCmd() *cobra.Command {
 	var deleteCloudResourcesFlag bool
 
 	var cmd = &cobra.Command{
-		Use:   "down [run1] [run2] ...",
-		Short: "Undeploy the application",
-		Long:  "Undeploy the application",
+		Use:     "down [run1] [run2] ...",
+		GroupID: runGroup.ID,
+		Short:   "Undeploy a run",
+		Long:    "Undeploy a run",
 	}
 
 	cmd.Flags().BoolVarP(&deleteNamespaceFlag, "delete-namespace", "N", false, "Also delete namespace (only for empty namespaces)")

diff --git a/cmd/subcommands/info.go b/cmd/subcommands/info.go
@@ -10,8 +10,9 @@ import (
 
 func newInfoCommand() *cobra.Command {
 	var cmd = &cobra.Command{
-		Use:   "info",
-		Short: "Summary information of the application",
+		Use:     "info",
+		GroupID: applicationGroup.ID,
+		Short:   "Summary information of the application",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return info.UI()
 		},

diff --git a/cmd/subcommands/logs.go b/cmd/subcommands/logs.go
@@ -21,10 +21,11 @@ func newLogsCommand() *cobra.Command {
 	var tailFlag int
 
 	var cmd = &cobra.Command{
-		Use:   "logs",
-		Short: "Print or stream logs from the application",
-		Long:  "Print or stream logs from the application",
-		Args:  cobra.MatchAll(cobra.ExactArgs(0), cobra.OnlyValidArgs),
+		Use:     "logs",
+		GroupID: runGroup.ID,
+		Short:   "Print or stream logs from a run",
+		Long:    "Print or stream logs from a run",
+		Args:    cobra.MatchAll(cobra.ExactArgs(0), cobra.OnlyValidArgs),
 	}
 
 	cmd.Flags().StringSliceVarP(&componentsFlag, "component", "c", []string{"workers"}, "Components to track (workers|dispatcher|workstealer|minio)")

diff --git a/cmd/subcommands/queue.go b/cmd/subcommands/queue.go
@@ -10,8 +10,9 @@ import (
 
 func init() {
 	cmd := &cobra.Command{
-		Use:   "queue",
-		Short: "Commands related to the queue",
+		Use:     "queue",
+		GroupID: internalGroup.ID,
+		Short:   "Commands related to the queue",
 	}
 	rootCmd.AddCommand(cmd)
 

diff --git a/cmd/subcommands/queue_full.go b/cmd/subcommands/queue_full.go
@@ -11,8 +11,9 @@ import (
 
 func init() {
 	cmd := &cobra.Command{
-		Use:   "queue",
-		Short: "Commands related to the queue",
+		Use:     "queue",
+		GroupID: internalGroup.ID,
+		Short:   "Commands related to the queue",
 	}
 	rootCmd.AddCommand(cmd)
 

diff --git a/cmd/subcommands/root.go b/cmd/subcommands/root.go
@@ -4,6 +4,7 @@ import (
 	"os"
 
 	"github.com/spf13/cobra"
+
 	"lunchpail.io/pkg/build"
 )
 
@@ -12,6 +13,10 @@ var rootCmd = &cobra.Command{
 	Use: "lunchpail",
 }
 
+var applicationGroup = &cobra.Group{ID: "Application", Title: "Application Commands"}
+var runGroup = &cobra.Group{ID: "Run", Title: "Run Commands"}
+var internalGroup = &cobra.Group{ID: "Internal", Title: "Advanced/Internal Commands"}
+
 func Execute() error {
 	if build.IsBuilt() {
 		rootCmd.Use = build.Name()
@@ -25,6 +30,12 @@ func Execute() error {
 }
 
 func init() {
+	rootCmd.AddGroup(applicationGroup)
+	if build.IsBuilt() {
+		rootCmd.AddGroup(runGroup)
+	}
+	rootCmd.AddGroup(internalGroup)
+
 	// To tell Cobra to mark the default completion command as
 	// hidden (see
 	// https://github.com/spf13/cobra/blob/main/site/content/completions/_index.md#adapting-the-default-completion-command)

diff --git a/cmd/subcommands/status.go b/cmd/subcommands/status.go
@@ -12,8 +12,9 @@ import (
 func init() {
 	if build.IsBuilt() {
 		cmd := &cobra.Command{
-			Use:   "status",
-			Short: "Commands related to run status",
+			Use:     "status",
+			GroupID: runGroup.ID,
+			Short:   "Commands related to the status of a run",
 		}
 
 		rootCmd.AddCommand(cmd)

diff --git a/cmd/subcommands/up.go b/cmd/subcommands/up.go
@@ -20,10 +20,11 @@ func newUpCmd() *cobra.Command {
 	var createCluster bool
 
 	var cmd = &cobra.Command{
-		Use:   "up [inputFilesOrDirectories...]",
-		Short: "Deploy the application",
-		Long:  "Deploy the application",
-		Args:  cobra.MatchAll(cobra.OnlyValidArgs),
+		Use:     "up [inputFilesOrDirectories...]",
+		GroupID: applicationGroup.ID,
+		Short:   "Deploy the application",
+		Long:    "Deploy the application",
+		Args:    cobra.MatchAll(cobra.OnlyValidArgs),
 	}
 
 	if util.StdoutIsTty() {