flags

Documentation

Overview

Package flags contains flags that are commonly used by several commands.

Index

• func AcceptDefaults(a *bool) *cli.BoolVar
• func DebugScratchContents(d *bool) *cli.BoolVar
• func DebugStepDiffs(d *bool) *cli.BoolVar
• func GitProtocol(target *string) *cli.StringVar
• func InputFiles(inputFiles *[]string) *cli.StringSliceVar
• func Inputs(inputs *map[string]string) *cli.StringMapVar
• func KeepTempDirs(k *bool) *cli.BoolVar
• func Prompt(p *bool) *cli.BoolVar
• func SkipInputValidation(s *bool) *cli.BoolVar
• func UpgradeChannel(u *string) *cli.StringVar
• func Verbose(v *bool) *cli.BoolVar

Functions

func AcceptDefaults

func AcceptDefaults(a *bool) *cli.BoolVar

AcceptDefaults causes template defaults to be accepted automatically when prompting is disabled.

func DebugScratchContents

func DebugScratchContents(d *bool) *cli.BoolVar

DebugScratchContents causes the contents of the scratch directory to be logged at level INFO after each step of the spec.yaml.

func DebugStepDiffs

func DebugStepDiffs(d *bool) *cli.BoolVar

DebugStepDiffs causes the diffs between steps to be logged as git commits.

func GitProtocol

func GitProtocol(target *string) *cli.StringVar

GitProtocol is a flag that's either https or ssh. It controls how we talk to remote git servers like GitHub.

func InputFiles

func InputFiles(inputFiles *[]string) *cli.StringSliceVar

InputFiles are the files containing a YAML template inputs, similar to --input.

func Inputs

func Inputs(inputs *map[string]string) *cli.StringMapVar

Inputs provide values that are substituted into the template. The keys in this map must match the input names in the Source template's spec.yaml file.

These are just the --input values from flags. It doesn't include inputs from config files, defaults, or prompts.

func KeepTempDirs

func KeepTempDirs(k *bool) *cli.BoolVar

KeepTempDirs prevents the cleanup of temporary directories after rendering is complete. This can be useful for debugging a failing template.

func Prompt

func Prompt(p *bool) *cli.BoolVar

Prompt causes the user to be prompted for any needed input values.

func SkipInputValidation

func SkipInputValidation(s *bool) *cli.BoolVar

SkipInputValidation skips the execution of the input validation rules as configured in the template's spec.yaml file.

func UpgradeChannel

func UpgradeChannel(u *string) *cli.StringVar

func Verbose

func Verbose(v *bool) *cli.BoolVar

Verbose causes more output to be produced.