etcdctl: hide global flags

Signed-off-by: hwdef <[email protected]>

Author: hwdef

etcdctl/ctlv3/command/options_command.go

@@ -0,0 +1,32 @@
+package command
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
+)
+
+func NewOptionsCommand(rootCmd *cobra.Command) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "options",
+		Short: "Show the global command-line flags",
+		Run: func(cmd *cobra.Command, args []string) {
+			fs := unhideCopy(rootCmd.PersistentFlags())
+			fmt.Fprintf(cmd.OutOrStdout(), "The following options can be passed to any command:\n\n")
+			fmt.Fprint(cmd.OutOrStdout(), fs.FlagUsages())
+		},
+		GroupID: groupUtilityID,
+	}
+	return cmd
+}
+
+func unhideCopy(src *pflag.FlagSet) *pflag.FlagSet {
+	out := pflag.NewFlagSet("global", pflag.ContinueOnError)
+	src.VisitAll(func(f *pflag.Flag) {
+		nf := *f
+		nf.Hidden = false
+		out.AddFlag(&nf)
+	})
+	return out
+}

etcdctl/ctlv3/ctl.go

@@ -16,10 +16,12 @@
 package ctlv3
 
 import (
+	"fmt"
 	"os"
 	"time"
 
 	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 
 	"go.etcd.io/etcd/etcdctl/v3/ctlv3/command"
 	"go.etcd.io/etcd/pkg/v3/cobrautl"
@@ -106,9 +108,13 @@ func init() {
 		command.NewCheckCommand(),
 		command.NewCompletionCommand(),
 		command.NewDowngradeCommand(),
+		command.NewOptionsCommand(rootCmd),
 	)
-
 	command.SetHelpCmdGroup(rootCmd)
+
+	hideAllPersistentFlags()
+	hideHelpFlag()
+	addOptionsPrompt()
 }
 
 func Start() error {
@@ -124,6 +130,28 @@ func MustStart() {
 	}
 }
 
+func hideAllPersistentFlags() {
+	rootCmd.PersistentFlags().VisitAll(func(f *pflag.Flag) {
+		rootCmd.PersistentFlags().MarkHidden(f.Name)
+	})
+	rootCmd.Flags().MarkHidden("help")
+}
+
+func hideHelpFlag() {
+	if rootCmd.Flags().Lookup("help") == nil {
+		rootCmd.Flags().BoolP("help", "h", false, "help for "+rootCmd.Name())
+	}
+	_ = rootCmd.Flags().MarkHidden("help")
+}
+
+func addOptionsPrompt() {
+	defaultHelpFunc := rootCmd.HelpFunc()
+	rootCmd.SetHelpFunc(func(cmd *cobra.Command, args []string) {
+		defaultHelpFunc(cmd, args)
+		fmt.Fprintln(cmd.OutOrStdout(), `Use "etcdctl options" for a list of global command-line options (applies to all commands).`)
+	})
+}
+
 func init() {
 	cobra.EnablePrefixMatching = true
 }