istio.io/istio@v0.0.0-20240520182934-d79c90f27776/istioctl/cmd/options.go (about)

     1  // Copyright Istio Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package cmd
    16  
    17  import (
    18  	"github.com/spf13/cobra"
    19  	"github.com/spf13/pflag"
    20  )
    21  
    22  var helpFlags = map[string]bool{
    23  	"log_as_json":          true,
    24  	"log_stacktrace_level": true,
    25  	"log_target":           true,
    26  	"log_caller":           true,
    27  	"log_output_level":     true,
    28  	// istioctl also inherits support for log_rotate, log_rotate_max_age, log_rotate_max_backups,
    29  	// log_rotate_max_size, but these are rarely appropriate for a user-facing CLI so we ignore them
    30  }
    31  
    32  func optionsCommand(rootCmd *cobra.Command) *cobra.Command {
    33  	retval := &cobra.Command{
    34  		Use:   "options",
    35  		Short: "Displays istioctl global options",
    36  		Args:  cobra.ExactArgs(0),
    37  	}
    38  
    39  	retval.SetHelpFunc(func(c *cobra.Command, args []string) {
    40  		c.Printf("The following options can be passed to any command:\n")
    41  		// (Currently the only global options we show are help options)
    42  		rootCmd.PersistentFlags().VisitAll(func(flag *pflag.Flag) {
    43  			if _, ok := helpFlags[flag.Name]; ok {
    44  				// Currently every flag.Shorthand is "", so there is no point in showing shorthands
    45  				shorthand := "   "
    46  				if flag.Shorthand != "" {
    47  					shorthand = "-" + flag.Shorthand + ","
    48  				}
    49  				c.Printf("  %s --%s: %s\n", shorthand, flag.Name, flag.Usage)
    50  			}
    51  		})
    52  	})
    53  
    54  	return retval
    55  }