cmd

Documentation

Index

• func AddFlag(cmd Flag)
• func Execute()
• func Gen(cmd *cobra.Command, args []string)
• func Go(cmd *cobra.Command, args []string)
• func Infr(cmd *cobra.Command, args []string)
• func List(cmd *cobra.Command, args []string)
• func WarnDefault(actual string, initial string)
• type Flag

Functions

func AddFlag

func AddFlag(cmd Flag)

Function to add new command to CLI tool.

func Execute

func Execute()

func Gen

func Gen(cmd *cobra.Command, args []string)

func Go

func Go(cmd *cobra.Command, args []string)

func Infr

func Infr(cmd *cobra.Command, args []string)

func List

func List(cmd *cobra.Command, args []string)

func WarnDefault

func WarnDefault(actual string, initial string)

Types

type Flag

type Flag struct {
	// Cobra command that we will bound our cmd to
	Cmd *cobra.Command
	// Name of command in CLI
	Name string
	// Optional short name for command, leave empty to skip short name
	ShortName string
	// Environment variable to read from
	Env string
	// Regular name for the flag
	Value string
	// Wether this value should be provided by user
	IsRequired bool
	// Leave empty if type is string: ["", "strarr", "bool"]
	Type string
	// Description for flag
	Description string
}

Short description of contents for command.