cli

Documentation

Overview

Package cli is responsible for managing the command-line interface.

Index

• type RootCommand
  • func NewRootCommand() *RootCommand
  • func (c *RootCommand) GetCommandLineFlags(cmd *cobra.Command) map[string]bool
  • func (c *RootCommand) GetExitCode() int
  • func (c *RootCommand) SetExitCode(code int)

Types

type RootCommand

type RootCommand struct {
	*cobra.Command
	// contains filtered or unexported fields
}

RootCommand is the root command of the application.

func NewRootCommand

func NewRootCommand() *RootCommand

NewRootCommand creates and initializes a new RootCommand object.

func (*RootCommand) GetCommandLineFlags

func (c *RootCommand) GetCommandLineFlags(cmd *cobra.Command) map[string]bool

GetCommandLineFlags returns a map of all global and command-specified flags passed via the command line.

If a flag was not passed, it will not be present in the map. This will allow the caller to quickly determine whether or not a flag was specified on the command line rather than having to traverse an entire array.

The boolean value the flag is mapped to will always be true.

func (*RootCommand) GetExitCode

func (c *RootCommand) GetExitCode() int

GetExitCode retrieves the exit code for the application.

func (*RootCommand) SetExitCode

func (c *RootCommand) SetExitCode(code int)

SetExitCode sets the exit code for the application.