feat: remove alias in commands and add version injection for cli

internal/cli/cli.go

@@ -28,7 +28,7 @@ func NewCliCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "obocli",
 		Short: "OceanBase Operator Cli",
-		Long:  "OceanBase Operator Cli tool to manage OceanBase clusters, tenants, and backups.",
+		Long:  "OceanBase Operator Cli tool to manage OceanBase clusters, tenants, and backup policies.",
 		Run: func(cmd *cobra.Command, args []string) {
 			if cmd.Flags().Changed("version") {
 				versionCmd := version.NewCmd()

internal/cli/cmd/cluster/cluster.go

@@ -20,10 +20,9 @@ import (
 // NewCmd is command for cluster management
 func NewCmd() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "cluster <subcommand>",
-		Aliases: []string{"c"},
-		Short:   "Command for OBCluster's management",
-		Long:    `Command for OBCluster's management, such as Create, UpGrade, Delete, Scale, Show.`,
+		Use:   "cluster <subcommand>",
+		Short: "Command for OBCluster's management",
+		Long:  `Command for OBCluster's management, such as Create, UpGrade, Delete, Scale, Show.`,
 	}
 	cmd.AddCommand(NewCreateCmd())
 	cmd.AddCommand(NewDeleteCmd())

internal/cli/cmd/cluster/create.go

@@ -29,7 +29,6 @@ func NewCreateCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "create <cluster_name>",
 		Short:   "Create an ob cluster",
-		Aliases: []string{"c"},
 		Args:    cobra.ExactArgs(1),
 		PreRunE: o.Parse,
 		Run: func(cmd *cobra.Command, args []string) {

internal/cli/cmd/cluster/delete.go

@@ -28,7 +28,6 @@ func NewDeleteCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "delete <cluster_name>",
 		Short:   "Delete an ob cluster",
-		Aliases: []string{"d"},
 		Args:    cobra.ExactArgs(1),
 		PreRunE: o.Parse,
 		Run: func(cmd *cobra.Command, args []string) {

internal/cli/cmd/cluster/list.go

@@ -27,10 +27,9 @@ func NewListCmd() *cobra.Command {
 	tbw, tbLog := cmdUtil.GetTableLoggerInstance()
 	logger := cmdUtil.GetDefaultLoggerInstance()
 	cmd := &cobra.Command{
-		Use:     "list",
-		Short:   "List ob clusters",
-		Long:    `List ob clusters.`,
-		Aliases: []string{"ls", "l"},
+		Use:   "list",
+		Short: "List ob clusters",
+		Long:  `List ob clusters.`,
 		Run: func(cmd *cobra.Command, args []string) {
 			obclusterList, err := clients.ListAllOBClusters(cmd.Context())
 			if err != nil {

internal/cli/cmd/cluster/update.go

@@ -30,7 +30,6 @@ func NewUpdateCmd() *cobra.Command {
 		Short:   "Update an ob cluster",
 		Long:    "Update an ob cluster, support cpu/memory/storage",
 		Args:    cobra.ExactArgs(1),
-		Aliases: []string{"ud"},
 		PreRunE: o.Parse,
 		Run: func(cmd *cobra.Command, args []string) {
 			if err := o.Validate(); err != nil {

internal/cli/cmd/cluster/upgrade.go

@@ -30,7 +30,6 @@ func NewUpgradeCmd() *cobra.Command {
 		Short:   "Upgrade an ob cluster",
 		Long:    "Upgrade an ob cluster, please specify the new image",
 		Args:    cobra.ExactArgs(1),
-		Aliases: []string{"ug"},
 		PreRunE: o.Parse,
 		Run: func(cmd *cobra.Command, args []string) {
 			if err := o.Validate(); err != nil {

internal/cli/cmd/install/install.go

@@ -25,9 +25,8 @@ func NewCmd() *cobra.Command {
 	o := install.NewInstallOptions()
 	logger := cmdUtil.GetDefaultLoggerInstance()
 	cmd := &cobra.Command{
-		Use:     "install <component>",
-		Aliases: []string{"i"},
-		Short:   "Command for ob-operator and components installation",
+		Use:   "install <component>",
+		Short: "Command for ob-operator and components installation",
 		Long: `Command for ob-operator and components installation.
 
 Currently support:

internal/cli/cmd/tenant/create.go

@@ -27,7 +27,6 @@ func NewCreateCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "create <tenant_name> --cluster=<cluster_name>",
 		Short:   "Create an ob tenant",
-		Aliases: []string{"c"},
 		PreRunE: o.Parse,
 		Args:    cobra.ExactArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {

internal/cli/cmd/tenant/delete.go

@@ -29,7 +29,6 @@ func NewDeleteCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "delete <tenant_name>",
 		Short:   "Delete an ob tenant",
-		Aliases: []string{"d"},
 		Args:    cobra.ExactArgs(1),
 		PreRunE: o.Parse,
 		Run: func(cmd *cobra.Command, args []string) {

internal/cli/cmd/tenant/list.go

@@ -30,10 +30,9 @@ func NewListCmd() *cobra.Command {
 	tbw, tbLog := cmdUtil.GetTableLoggerInstance()
 	logger := cmdUtil.GetDefaultLoggerInstance()
 	cmd := &cobra.Command{
-		Use:     "list",
-		Short:   "List ob tenants",
-		Long:    `List ob tenants.`,
-		Aliases: []string{"ls", "l"},
+		Use:   "list",
+		Short: "List ob tenants",
+		Long:  `List ob tenants.`,
 		Run: func(cmd *cobra.Command, args []string) {
 			obtenantList, err := clients.ListAllOBTenants(cmd.Context(), o.Namespace, v1.ListOptions{})
 			if err != nil {

internal/cli/cmd/tenant/replaylog.go

@@ -30,7 +30,6 @@ func NewReplayLogCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:     "replaylog <tenant_name>",
 		Short:   "replay log of an ob tenant",
-		Aliases: []string{"r", "rl"},
 		Args:    cobra.ExactArgs(1),
 		PreRunE: o.Parse,
 		Run: func(cmd *cobra.Command, args []string) {

internal/cli/cmd/tenant/tenant.go

@@ -20,10 +20,9 @@ import (
 // NewCmd is command for tenant management
 func NewCmd() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "tenant",
-		Aliases: []string{"t"},
-		Short:   "Command for OBTenant's management",
-		Long:    `Command for OBTenant's management, such as Create, Update, Delete, Switchover, Activate, Replaylog.`,
+		Use:   "tenant",
+		Short: "Command for OBTenant's management",
+		Long:  `Command for OBTenant's management, such as Create, Update, Delete, Switchover, Activate, Replaylog.`,
 	}
 	cmd.AddCommand(NewCreateCmd())
 	cmd.AddCommand(NewDeleteCmd())

internal/cli/cmd/tenant/update.go

@@ -31,7 +31,6 @@ func NewUpdateCmd() *cobra.Command {
 		Short:   "Update an ob tenant",
 		Long:    "Update an ob tenant, support unitNumber/connectWhiteList/priority of zones",
 		Args:    cobra.ExactArgs(1),
-		Aliases: []string{"ud"},
 		PreRunE: o.Parse,
 		Run: func(cmd *cobra.Command, args []string) {
 			obtenant, err := clients.GetOBTenant(cmd.Context(), types.NamespacedName{

internal/cli/cmd/tenant/upgrade.go

@@ -31,7 +31,6 @@ func NewUpgradeCmd() *cobra.Command {
 		Short:   "Upgrade an ob tenant to compatible version to the ob cluster",
 		Long:    `Upgrade an ob tenant to higher version, suitable for restoring low-version backup data to a high-version ob cluster.`,
 		Args:    cobra.ExactArgs(1),
-		Aliases: []string{"ug"},
 		PreRunE: o.Parse,
 		Run: func(cmd *cobra.Command, args []string) {
 			if err := o.Validate(); err != nil {

internal/cli/cmd/update/update.go

@@ -25,9 +25,8 @@ func NewCmd() *cobra.Command {
 	o := update.NewUpdateOptions()
 	logger := cmdUtil.GetDefaultLoggerInstance()
 	cmd := &cobra.Command{
-		Use:     "update <components>",
-		Aliases: []string{"u"},
-		Short:   "Command for ob-operator and components update",
+		Use:   "update <components>",
+		Short: "Command for ob-operator and components update",
 		Long: `Command for ob-operator and components update.
 
 Currently support:

internal/cli/cmd/version/version.go

@@ -14,19 +14,83 @@ See the Mulan PSL v2 for more details.
 package version
 
 import (
+	"os"
+	"runtime"
+	"text/tabwriter"
+	"text/template"
+	"time"
+
 	"github.com/spf13/cobra"
+)
 
-	cmdUtil "github.com/oceanbase/ob-operator/internal/cli/cmd/util"
+// Injected by build script
+var (
+	OS         = ""
+	Arch       = ""
+	Version    = ""
+	CommitHash = ""
+	BuildTime  = ""
 )
 
+// defaultVersionTemplate is the default template for displaying version information.
+const defaultVersionTemplate = `
+OceanBase Operatore Cli:
+ Version:    {{.Version}}
+ OS/Arch:	{{.OS}}/{{.Arch}}
+ Go Version: {{.GoVersion}}
+ Git Commit: {{.CommitHash}}
+ Build Time: {{.BuildTime}}
+`
+
+// VersionInfo stores the version information.
+type VersionInfo struct {
+	Version    string
+	OS         string
+	Arch       string
+	GoVersion  string
+	CommitHash string
+	BuildTime  string
+}
+
 func NewCmd() *cobra.Command {
-	logger := cmdUtil.GetDefaultLoggerInstance()
 	cmd := &cobra.Command{
 		Use:   "version",
 		Short: "Print the version number of OceanBase Cli",
-		Run: func(cmd *cobra.Command, args []string) {
-			logger.Println("OceanBase Cli Version: 0.0.1")
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return printCliInfo()
 		},
 	}
 	return cmd
 }
+
+func reformatTime(buildTime string) string {
+	t, err := time.Parse("20060102150405", buildTime)
+	if err != nil {
+		return buildTime
+	}
+	return t.Format("2006-01-02 15:04:05")
+}
+
+// printCliInfo prints the version information of OceanBase Cli.
+func printCliInfo() error {
+	t := tabwriter.NewWriter(os.Stdout, 10, 1, 1, ' ', 0)
+	tmpl, err := template.New("version").Parse(defaultVersionTemplate)
+	data := &VersionInfo{
+		Version:    Version,
+		OS:         runtime.GOOS,
+		Arch:       runtime.GOARCH,
+		GoVersion:  runtime.Version(),
+		CommitHash: CommitHash,
+		BuildTime:  reformatTime(BuildTime),
+	}
+	if err != nil {
+		return err
+	}
+	if err := tmpl.Execute(t, data); err != nil {
+		return err
+	}
+	if _, err := t.Write([]byte("\n")); err != nil {
+		return err
+	}
+	return t.Flush()
+}

make/cli.mk

@@ -4,6 +4,9 @@ BINARY_NAME ?= obocli
 CLI_VERSION ?= 0.1.0
 GOARCH ?=$(shell uname -m)
 GOOS ?= $(shell uname -s | tr LD ld)
+VERSION_INJECT_PACKAGE=github.com/oceanbase/ob-operator/internal/cli/cmd/version
+COMMIT_HASH ?= $(shell git rev-parse --short HEAD)
+BUILD_TIMESTAMP ?= $(shell date '+%Y%m%d%H%M%S')
 
 # If GOARCH not specified, set GOARCH based on the detected architecture
 ifeq ($(GOARCH),x86_64)
@@ -12,8 +15,9 @@ else ifeq ($(GOARCH),aarch64)
     GOARCH = arm64
 endif
 
+CLI_BUILD_FLAGS = -p 4 -ldflags="-X '$(VERSION_INJECT_PACKAGE).Version=$(CLI_VERSION)' -X '$(VERSION_INJECT_PACKAGE).CommitHash=$(COMMIT_HASH)' -X '$(VERSION_INJECT_PACKAGE).BuildTime=$(BUILD_TIMESTAMP)' "
 # build args
-CLI_BUILD := GO11MODULE=ON CGO_ENABLED=0 GOOS=$(GOOS) GOARCH=$(GOARCH) go build
+CLI_BUILD := GO11MODULE=ON CGO_ENABLED=0 GOOS=$(GOOS) GOARCH=$(GOARCH) go build $(CLI_BUILD_FLAGS)
 
 # build dir for obocli 
 BUILD_DIR?=bin/