flagutil

Documentation

Overview

Package flagutil is a helper package for processing and interactive command line flags

Index

• Variables
• func EnableOutputFlagCompletion(cmd *cobra.Command)
• func EnableStaticFlagCompletion(cmd *cobra.Command, flagName string, validValues []string)
• func FlagDescription(localizer localize.Localizer, messageID string, validOptions ...string) string
• func IsValidInput(input string, validValues ...string) bool
• func RegisterGroupCompletionFunc(cmd *cobra.Command, f *factory.Factory) error
• func RegisterServiceAccountCompletionFunc(cmd *cobra.Command, f *factory.Factory) error
• func RegisterTopicCompletionFunc(cmd *cobra.Command, f *factory.Factory) error
• func RegisterUserCompletionFunc(cmd *cobra.Command, flagName string, f *factory.Factory) error
• type FlagOptions
  • func WithFlagOptions(cmd *cobra.Command, flagName string) *FlagOptions
• type FlagSet
  • func NewFlagSet(cmd *cobra.Command, localizer localize.Localizer) *FlagSet
  • func (fs *FlagSet) AddBypassTermsCheck(bypass *bool)
  • func (fs *FlagSet) AddOutput(output *string)
  • func (fs *FlagSet) AddPage(page *int32)
  • func (fs *FlagSet) AddSize(page *int32)
  • func (fs *FlagSet) AddYes(yes *bool)

Variables

var (
	ValidOutputFormats       = []string{dump.JSONFormat, dump.YAMLFormat, dump.YMLFormat}
	CredentialsOutputFormats = []string{credentials.EnvFormat, credentials.JSONFormat, credentials.PropertiesFormat}
)

Functions

func EnableOutputFlagCompletion

func EnableOutputFlagCompletion(cmd *cobra.Command)

EnableOutputFlagCompletion enables autocompletion for output flag

func EnableStaticFlagCompletion

func EnableStaticFlagCompletion(cmd *cobra.Command, flagName string, validValues []string)

EnableStaticFlagCompletion enables autocompletion for flags with predefined valid values

func FlagDescription

func FlagDescription(localizer localize.Localizer, messageID string, validOptions ...string) string

FlagDescription creates a flag description and adds a list of valid options (if any)

func IsValidInput

func IsValidInput(input string, validValues ...string) bool

IsValidInput checks if the input value is in the range of valid values

func RegisterGroupCompletionFunc

func RegisterGroupCompletionFunc(cmd *cobra.Command, f *factory.Factory) error

RegisterGroupCompletionFunc enables dynamic autocompletion for group flag

func RegisterServiceAccountCompletionFunc

func RegisterServiceAccountCompletionFunc(cmd *cobra.Command, f *factory.Factory) error

RegisterServiceAccountCompletionFunc adds the service account list to flag dynamic completion

func RegisterTopicCompletionFunc

func RegisterTopicCompletionFunc(cmd *cobra.Command, f *factory.Factory) error

RegisterTopicCompletionFunc enables dynamic autocompletion for topic flag

func RegisterUserCompletionFunc

func RegisterUserCompletionFunc(cmd *cobra.Command, flagName string, f *factory.Factory) error

RegisterUserCompletionFunc adds the user list to flag dynamic completion

Types

type FlagOptions

type FlagOptions struct {
	Required func() error
}

FlagOptions defines additional flag options

func WithFlagOptions

func WithFlagOptions(cmd *cobra.Command, flagName string) *FlagOptions

WithFlagOptions returns additional functions to custom the default flag settings

type FlagSet

type FlagSet struct {
	*pflag.FlagSet
	// contains filtered or unexported fields
}

func NewFlagSet

func NewFlagSet(cmd *cobra.Command, localizer localize.Localizer) *FlagSet

NewFlagSet returns a new flag set with some common flags

func (*FlagSet) AddBypassTermsCheck

func (fs *FlagSet) AddBypassTermsCheck(bypass *bool)

AddBypassTermsCheck adds a flag to allow bypassing of the terms check before creating an instance

func (*FlagSet) AddOutput

func (fs *FlagSet) AddOutput(output *string)

AddOutput adds an output flag to the command

func (*FlagSet) AddPage

func (fs *FlagSet) AddPage(page *int32)

AddPage adds a "page" flag to the command

func (*FlagSet) AddSize

func (fs *FlagSet) AddSize(page *int32)

AddSize adds a "size" flag to the command

func (*FlagSet) AddYes

func (fs *FlagSet) AddYes(yes *bool)

AddYes adds a "yes" flag to the command