cmd

Documentation

Index

• Constants
• Variables
• func AddDefaults(c *cobra.Command)
• func Execute(cmd *cobra.Command)
• func Test(cmd *cobra.Command) int
• func Wrap(name string, src *cobra.Command)

Constants

const (
	GroupAnnotationLabel = "Group"
	StackGroup           = "Stack commands"
	TemplateGroup        = "Template commands"
)

Labels used as annotations on commands to provide grouping

Variables

var Groups = []string{
	StackGroup,
	TemplateGroup,
}

Groups represents the ordering of commands in Rain's help text

var StackAnnotation = map[string]string{GroupAnnotationLabel: StackGroup}

StackAnnotation is used by rain sub-commands to register as commands in the stack group

var TemplateAnnotation = map[string]string{GroupAnnotationLabel: TemplateGroup}

TemplateAnnotation is used by rain sub-commands to register as commands in the template group

Functions

func AddDefaults

func AddDefaults(c *cobra.Command)

AddDefaults add standard additional flags and version information to a command

func Execute

func Execute(cmd *cobra.Command)

Execute wraps a command with error trapping that deals with the debug flag

func Test

func Test(cmd *cobra.Command) int

Test runs a command without calling os.Exit and instead returning the error code. Use this in place of Execute for functional testing

func Wrap

func Wrap(name string, src *cobra.Command)

Wrap creates a new command with the same functionality as src but with a new name and default options added for executables e.g. the --debug flag The new command is then executed