flags

Documentation

Index

• Constants
• func AddClusterDefinitionFlag(f cmdutil.Factory, cmd *cobra.Command, p *string)
• func AddComponentFlag(f cmdutil.Factory, cmd *cobra.Command, p *string, usage string)
• func AddComponentsFlag(f cmdutil.Factory, cmd *cobra.Command, p *[]string, usage string)
• func BuildFlagsBySchema(cmd *cobra.Command, schema *spec.Schema) error
• func BuildFlagsWithOpenAPISchema(cmd *cobra.Command, args []string, ...) error
• func CompletedInstanceFlag(cmd *cobra.Command, f cmdutil.Factory, flag string) error
• func CompletedInstanceTemplatesFlag(cmd *cobra.Command, f cmdutil.Factory, flag string) error
• func FlagsToValues(fs *pflag.FlagSet, explicit bool) map[string]pflag.Value
• type TmpFlagSet
  • func NewTmpFlagSet() *TmpFlagSet
  • func (t *TmpFlagSet) Check(args []string, customCheckFunc func() error) error

Constants

const (
	CobraInt          = "int"
	CobraSting        = "string"
	CobraBool         = "bool"
	CobraFloat64      = "float64"
	CobraStringArray  = "stringArray"
	CobraIntSlice     = "intSlice"
	CobraFloat64Slice = "float64Slice"
	CobraBoolSlice    = "boolSlice"
)

Functions

func AddClusterDefinitionFlag

func AddClusterDefinitionFlag(f cmdutil.Factory, cmd *cobra.Command, p *string)

AddClusterDefinitionFlag adds a flag "cluster-definition" for the cmd and stores the value of the flag in string p

func AddComponentFlag

func AddComponentFlag(f cmdutil.Factory, cmd *cobra.Command, p *string, usage string)

AddComponentFlag add flag "component" for cobra.Command and support auto complete for it

func AddComponentsFlag

func AddComponentsFlag(f cmdutil.Factory, cmd *cobra.Command, p *[]string, usage string)

AddComponentsFlag add flag "components" for cobra.Command and support auto complete for it

func BuildFlagsBySchema

func BuildFlagsBySchema(cmd *cobra.Command, schema *spec.Schema) error

BuildFlagsBySchema builds a flag.FlagSet by the given schema, convert the schema key to flag name, and convert the schema type to flag type.

func BuildFlagsWithOpenAPISchema

func BuildFlagsWithOpenAPISchema(cmd *cobra.Command,
	args []string,
	getOpenAPISchema func() (*apiextensionsv1.JSONSchemaProps, error)) error

BuildFlagsWithOpenAPISchema builds the flag from openAPIV3Schema properties.

func CompletedInstanceFlag

func CompletedInstanceFlag(cmd *cobra.Command, f cmdutil.Factory, flag string) error

func CompletedInstanceTemplatesFlag

func CompletedInstanceTemplatesFlag(cmd *cobra.Command, f cmdutil.Factory, flag string) error

func FlagsToValues

func FlagsToValues(fs *pflag.FlagSet, explicit bool) map[string]pflag.Value

Types

type TmpFlagSet

type TmpFlagSet struct {
	*pflag.FlagSet
	// help flag
	Help bool
}

TmpFlagSet create a tmpFlagSet to handle your custom flags and args.

func NewTmpFlagSet

func NewTmpFlagSet() *TmpFlagSet

func (*TmpFlagSet) Check

func (t *TmpFlagSet) Check(args []string, customCheckFunc func() error) error

Check checks whether the args and flags of the command is valid. and you can specify a customCheckFunc to override the default check function.