commands

Documentation

Index

• Constants
• Variables
• type Root
  • func New() *Root
  • func (r *Root) AddCommands()
  • func (r *Root) AddFlags()
  • func (r *Root) CompletionCommand() *cobra.Command
  • func (r *Root) Completions(cmd *cobra.Command, args []string)
  • func (r *Root) Execute(cmd *cobra.Command, args []string)
  • func (r Root) NewCommand() *cobra.Command
  • func (r *Root) Run()
  • func (r *Root) SetupLogging(cmd *cobra.Command, args []string)

Constants

const (
	YotShort = "yot (YAML Overlay Tool) is a YAML overlay tool."

	YotLong = `` /* 220-byte string literal not displayed */

	HelpUsageExample = "yot -i instructions.yaml -o /tmp/output"

	HelpVerbose = "Verbose log-level stdout, equivalent to '--log-level debug'"

	HelpLogLevel = `` /* 288-byte string literal not displayed */

	HelpInstructionsFile = "Path to the instructions file (required)"

	HelpOutputDirectory = `Path to a directory for writing the YAML files which were operated on by yot`

	HelpRenderStdOut = `Output YAML files which were operated on by yot to stdout`

	HelpIndentLevel = `Number of spaces to be used for indenting YAML output (min: 2, max: 9)`

	HelpOutputStyle = `` /* 432-byte string literal not displayed */

	CompletionUse   = "completion [bash|zsh|fish|powershell]"
	CompletionShort = "Generate shell auto-completion scripts"

	CompletionLong = `` /* 1018-byte string literal not displayed */

)

Variables

var ErrMissingRequired = fmt.Errorf("missing required arguments")

ErrMissingRequired occurs when a required flag is not passed.

Types

type Root

type Root struct {
	Log     *logging.Logger
	Options *instructions.Config
	Command *cobra.Command
}

func New

func New() *Root

func (*Root) AddCommands

func (r *Root) AddCommands()

func (*Root) AddFlags

func (r *Root) AddFlags()

func (*Root) CompletionCommand

func (r *Root) CompletionCommand() *cobra.Command

func (*Root) Completions

func (r *Root) Completions(cmd *cobra.Command, args []string)

func (*Root) Execute

func (r *Root) Execute(cmd *cobra.Command, args []string)

func (Root) NewCommand

func (r Root) NewCommand() *cobra.Command

func (*Root) Run

func (r *Root) Run()

func (*Root) SetupLogging

func (r *Root) SetupLogging(cmd *cobra.Command, args []string)