cli

Documentation

Index

• type AbstractCommand
  • func ParseInputs() (AbstractCommand, error)
• type CLICommand
  • func NewCLICommand() *CLICommand
  • func (cc *CLICommand) Init(args []string) error
  • func (cc *CLICommand) Is(group string) bool
  • func (cc *CLICommand) Logger() *log.Logger
  • func (cc *CLICommand) Name() string
  • func (cc *CLICommand) Run() error
  • func (cc *CLICommand) Usage()
• type ServerCommand
  • func NewServerCommand() *ServerCommand
  • func (sc *ServerCommand) Init(args []string) error
  • func (sc *ServerCommand) Is(group string) bool
  • func (sc *ServerCommand) Name() string
  • func (sc *ServerCommand) Run() error
  • func (sc *ServerCommand) Usage()

Types

type AbstractCommand

type AbstractCommand interface {
	// Run runs the command
	Run() error

	// Is checks if the string is representative of the command
	Is(string) bool

	// Init is an initializer for the command given the trailing args
	Init([]string) error

	// Name is the command name (for debugging)
	Name() string

	// Usage prints to standard error a usage message showing the default settings of all defined command-line flags
	Usage()
}

AbstractCommand represents a CLI grouping (e.g.: run as server, run as CLI, etc)

func ParseInputs

func ParseInputs() (AbstractCommand, error)

ParseInputs is a helper method which parses input arguments. It is effectively a factory method.

type CLICommand

type CLICommand struct {
	// contains filtered or unexported fields
}

CLICommand executed the provisioning as a CLI

func NewCLICommand

func NewCLICommand() *CLICommand

func (*CLICommand) Init

func (cc *CLICommand) Init(args []string) error

func (*CLICommand) Is

func (cc *CLICommand) Is(group string) bool

func (*CLICommand) Logger

func (cc *CLICommand) Logger() *log.Logger

Logger returns the log

func (*CLICommand) Name

func (cc *CLICommand) Name() string

func (*CLICommand) Run

func (cc *CLICommand) Run() error

func (*CLICommand) Usage

func (cc *CLICommand) Usage()

type ServerCommand

type ServerCommand struct {
	// contains filtered or unexported fields
}

ServerCommand executed the provisioning as a Server

func NewServerCommand

func NewServerCommand() *ServerCommand

func (*ServerCommand) Init

func (sc *ServerCommand) Init(args []string) error

func (*ServerCommand) Is

func (sc *ServerCommand) Is(group string) bool

func (*ServerCommand) Name

func (sc *ServerCommand) Name() string

func (*ServerCommand) Run

func (sc *ServerCommand) Run() error

func (*ServerCommand) Usage

func (sc *ServerCommand) Usage()