cli

Documentation

Overview

Responsible for the abstraction layer representing each command grouping

Represents the server command grouping

Index

• func SetUpLog(dir string) (*log.Logger, error)
• type AbstractCommand
  • func ParseInputs() (AbstractCommand, error)
• 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

Functions

func SetUpLog

func SetUpLog(dir string) (*log.Logger, error)

SetUpLog sets up the logging for the CLI

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
}

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 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