Merge pull request #409 from KeerthanaAP/add_group

Added groups for commands in help

cmd/create/create.go

@@ -22,9 +22,10 @@ import (
 )
 
 var Cmd = &cobra.Command{
-	Use:   "create",
-	Short: "Create the resources",
-	Long:  `Create the resources`,
+	Use:     "create",
+	Short:   "Create the resources",
+	Long:    `Create the resources`,
+	GroupID: "resource",
 }
 
 func init() {

cmd/delete/delete.go

@@ -22,9 +22,10 @@ import (
 )
 
 var Cmd = &cobra.Command{
-	Use:   "delete",
-	Short: "Delete the resources",
-	Long:  `Delete the resources`,
+	Use:     "delete",
+	Short:   "Delete the resources",
+	Long:    `Delete the resources`,
+	GroupID: "resource",
 }
 
 func init() {

cmd/dhcp-sync/dhcp-sync.go

@@ -149,9 +149,10 @@ func syncDHCPD() {
 }
 
 var Cmd = &cobra.Command{
-	Use:   "dhcp-sync",
-	Short: "dhcp-sync command",
-	Long:  `dhcp-sync tool is a tool populating the dhcpd.conf file from the PowerVS network and restart the dhcpd service.`,
+	Use:     "dhcp-sync",
+	Short:   "dhcp-sync command",
+	Long:    `dhcp-sync tool is a tool populating the dhcpd.conf file from the PowerVS network and restart the dhcpd service.`,
+	GroupID: "dhcp",
 	PreRunE: func(cmd *cobra.Command, args []string) error {
 		if pkg.Options.InstanceID == "" {
 			return fmt.Errorf("--instance-id is required")

cmd/dhcpserver/cmd.go

@@ -23,8 +23,9 @@ import (
 )
 
 var Cmd = &cobra.Command{
-	Use:   "dhcpserver",
-	Short: "dhcpserver command",
+	Use:     "dhcpserver",
+	Short:   "dhcpserver command",
+	GroupID: "dhcp",
 	PreRunE: func(cmd *cobra.Command, args []string) error {
 		if pkg.Options.APIKey == "" {
 			return fmt.Errorf("api-key can't be empty, pass the token via --api-key or set IBMCLOUD_API_KEY environment variable")

cmd/get/get.go

@@ -23,9 +23,10 @@ import (
 )
 
 var Cmd = &cobra.Command{
-	Use:   "get",
-	Short: "Get the resources",
-	Long:  `Get the resources`,
+	Use:     "get",
+	Short:   "Get the resources",
+	Long:    `Get the resources`,
+	GroupID: "resource",
 }
 
 func init() {

cmd/image/image.go

@@ -24,9 +24,10 @@ import (
 )
 
 var Cmd = &cobra.Command{
-	Use:   "image",
-	Short: "PowerVS Image management",
-	Long:  `PowerVS Image management`,
+	Use:     "image",
+	Short:   "PowerVS Image management",
+	Long:    `PowerVS Image management`,
+	GroupID: "image",
 }
 
 func init() {

cmd/purge/images/images.go

@@ -16,6 +16,7 @@ package images
 
 import (
 	"fmt"
+
 	"github.com/ppc64le-cloud/pvsadm/pkg"
 	"github.com/ppc64le-cloud/pvsadm/pkg/audit"
 	"github.com/ppc64le-cloud/pvsadm/pkg/client"

cmd/purge/purge.go

@@ -69,6 +69,7 @@ Examples:
   # Delete all the ssh keys starts with rdr-
   pvsadm purge keys --instance-name upstream-core --regexp "^rdr-.*"
 `,
+	GroupID: "resource",
 	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 		// Code block to execute the strict check mentioned in the rootcmd for the environment.
 		// This block is needed as a workaround mentioned in https://github.com/spf13/cobra/issues/252

cmd/purge/volumes/volumes.go

@@ -16,13 +16,14 @@ package volumes
 
 import (
 	"fmt"
+	"time"
+
 	"github.com/ppc64le-cloud/pvsadm/pkg"
 	"github.com/ppc64le-cloud/pvsadm/pkg/audit"
 	"github.com/ppc64le-cloud/pvsadm/pkg/client"
 	"github.com/ppc64le-cloud/pvsadm/pkg/utils"
 	"github.com/spf13/cobra"
 	"k8s.io/klog/v2"
-	"time"
 )
 
 var before time.Duration

cmd/root.go

@@ -63,6 +63,12 @@ func init() {
 	klog.InitFlags(nil)
 	flag.CommandLine.AddGoFlagSet(goflag.CommandLine)
 
+	rootCmd.AddGroup(&cobra.Group{ID: "resource", Title: "Resource Management Commands:"})
+	rootCmd.AddGroup(&cobra.Group{ID: "dhcp", Title: "DHCP Commands:"})
+	rootCmd.AddGroup(&cobra.Group{ID: "image", Title: "Image Commands:"})
+	rootCmd.AddGroup(&cobra.Group{ID: "admin", Title: "Administration Commands:"})
+	rootCmd.SetHelpCommandGroupID("admin")
+	rootCmd.SetCompletionCommandGroupID("admin")
 	rootCmd.AddCommand(purge.Cmd)
 	rootCmd.AddCommand(get.Cmd)
 	rootCmd.AddCommand(version.Cmd)

cmd/version/version.go

@@ -16,15 +16,17 @@ package version
 
 import (
 	"fmt"
-	"github.com/ppc64le-cloud/pvsadm/pkg/version"
 	"runtime"
 
+	"github.com/ppc64le-cloud/pvsadm/pkg/version"
+
 	"github.com/spf13/cobra"
 )
 
 var Cmd = &cobra.Command{
-	Use:   "version",
-	Short: "Print the version number",
+	Use:     "version",
+	Short:   "Print the version number",
+	GroupID: "admin",
 	Run: func(cmd *cobra.Command, args []string) {
 		fmt.Printf("Version: %s, GoVersion: %s\n", version.Get(), runtime.Version())
 	},