commands

Documentation

Index

• Constants
• Variables
• type Command
• type CompletionCommand
  • func (c CompletionCommand) Command() *cobra.Command
  • func (c CompletionCommand) Completions(cmd *cobra.Command, args []string)
• type RootCommand
  • func New() *RootCommand
  • func (rc RootCommand) Command() *cobra.Command
  • func (rc *RootCommand) Execute(cmd *cobra.Command, args []string)
  • func (rc *RootCommand) SetupLogging(cmd *cobra.Command, args []string)

Constants

const (
	// Version of YAML Overlay Tool.
	Version = "unstable"

	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 Command

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

type CompletionCommand

type CompletionCommand Command

func (CompletionCommand) Command

func (c CompletionCommand) Command() *cobra.Command

func (CompletionCommand) Completions

func (c CompletionCommand) Completions(cmd *cobra.Command, args []string)

type RootCommand

type RootCommand Command

func New

func New() *RootCommand

func (RootCommand) Command

func (rc RootCommand) Command() *cobra.Command

func (*RootCommand) Execute

func (rc *RootCommand) Execute(cmd *cobra.Command, args []string)

func (*RootCommand) SetupLogging

func (rc *RootCommand) SetupLogging(cmd *cobra.Command, args []string)