cli

Documentation

Index

• Variables
• func Run(opts ...Option) error
• type Author
• type Command
• type Commandor
• type Context
• type Flag
• type Instance
• type IntFlag
• type Option
  • func App(app Instance) Option
  • func BuildTime(buildTime string) Option
  • func BuildVersion(buildVersion string) Option
  • func Commands(commands ...Commandor) Option
  • func Config(src, conf interface{}) Option
  • func Debug(args ...bool) Option
  • func Flags(flags ...Flag) Option
  • func Logger(log logger.Logger) Option
  • func MigrationsPath(path string) Option
  • func Name(name string) Option
  • func Usage(descr string) Option
  • func Users(users []cli.Author) Option
• type Options
• type RunOptions
  • func NewRunOptions(opts *Options) (RunOptions, error)
• type StringFlag

Variables

var (
	// ErrAppNotPointer when app-instance not pointer to struct
	ErrAppNotPointer = errors.New("app must be a pointer to a struct")
	// ErrConfigNotPointer when app-instance not pointer to struct
	ErrConfigNotPointer = errors.New("config must be a pointer to a struct")
)

Functions

func Run

func Run(opts ...Option) error

Run creates instance of cli.App with Options. Validate options with https://github.com/go-playground/validator Required: - App instance - Logger

Types

type Author

type Author = cli.Author

Author represents someone who has contributed to a cli project.

type Command

type Command = cli.Command

Command is a subcommand for a cli.App.

type Commandor

type Commandor func(*Options) Command

Commandor closure for applying options to command

type Context

type Context = cli.Context

Context is a type that is passed through to each Handler action in a cli application. Context can be used to retrieve context-specific Args and parsed command-line options.

type Flag

type Flag = cli.Flag

Flag is a common interface related to parsing flags in cli. For more advanced flag parsing techniques, it is recommended that this interface be implemented.

type Instance

type Instance interface {
	Run(RunOptions) error
	Shutdown(ctx context.Context) error
}

Instance abstraction layer above Application

type IntFlag

type IntFlag = cli.IntFlag

IntFlag is a flag with type int

type Option

type Option func(*Options)

Option closure

func App

func App(app Instance) Option

App closure to set field in Options

func BuildTime

func BuildTime(buildTime string) Option

BuildTime closure to set field in Options

func BuildVersion

func BuildVersion(buildVersion string) Option

BuildVersion closure to set field in Options

func Commands

func Commands(commands ...Commandor) Option

Commands closure to set additional commands for CLI

func Config

func Config(src, conf interface{}) Option

Config closure to set config source and interface in Options

func Debug

func Debug(args ...bool) Option

Debug closure to set debug and quiet state of logger in Options

func Flags

func Flags(flags ...Flag) Option

Flags closure to set additional commands for CLI

func Logger

func Logger(log logger.Logger) Option

Logger closure to set field in Options

func MigrationsPath

func MigrationsPath(path string) Option

MigrationsPath closure to set param in Options

func Name

func Name(name string) Option

Name closure to set field in Options

func Usage

func Usage(descr string) Option

Usage closure to set field in Options

func Users

func Users(users []cli.Author) Option

Users closure to set field in Options

type Options

type Options struct {
	App             Instance
	Logger          logger.Logger `validate:"required"`
	ConfigSource    interface{}   `validate:"required"`
	ConfigInterface interface{}   `validate:"required"`
	DB              *pg.DB
	Redis           *redis.Client
	Users           []cli.Author
	Debug           bool
	Quiet           bool
	Usage           string
	Name            string
	BuildTime       string
	BuildVersion    string
	// contains filtered or unexported fields
}

Options for creating cli.App instance

type RunOptions

type RunOptions struct {
	DB           *pg.DB
	Redis        *redis.Client
	Logger       logger.Logger
	Debug        bool
	BuildTime    string
	BuildVersion string
}

RunOptions for pass db, redis, etc to application:

func NewRunOptions

func NewRunOptions(opts *Options) (RunOptions, error)

type StringFlag

type StringFlag = cli.StringFlag

StringFlag is a flag with type string