cmd

README

Cobra Command Wrapper

What does it do?

A wrapper to help to create Cobra CLI applications.

Improvements to be made

• 100% test coverage.
• Better covering for other features.

Documentation

Index

• func CreateFormatter(logFormat string) logrus.Formatter
• type Commander
  • func NewCommander(cmd *cobra.Command) *Commander
  • func (c *Commander) Execute() error
  • func (c *Commander) Init() *Commander
  • func (c *Commander) SetCommand(cmds ...*cobra.Command) *Commander
  • func (c *Commander) SetConfig(config *Config) *Commander
  • func (c *Commander) SetPersistentFlags(p func(c *Commander)) *Commander
• type Config
  • func (c *Config) Init() *Config

Functions

func CreateFormatter

func CreateFormatter(logFormat string) logrus.Formatter

CreateFormatter create logrus formatter by string.

Types

type Commander

type Commander struct {
	Root   *cobra.Command
	Config *Config
}

Commander is a struct for command system.

func NewCommander

func NewCommander(cmd *cobra.Command) *Commander

NewCommander is a factory for Commander.

func (*Commander) Execute

func (c *Commander) Execute() error

Execute executes Cobra commands.

func (*Commander) Init

func (c *Commander) Init() *Commander

Init is entrypoint for the commands.

func (*Commander) SetCommand

func (c *Commander) SetCommand(cmds ...*cobra.Command) *Commander

SetCommand sets Root command.

func (*Commander) SetConfig

func (c *Commander) SetConfig(config *Config) *Commander

SetConfig sets Config for Commander.

func (*Commander) SetPersistentFlags

func (c *Commander) SetPersistentFlags(p func(c *Commander)) *Commander

SetPersistentFlags sets persistent flags.

type Config

type Config struct {
	Name              *string
	FileName          *string
	FileType          *string
	Path              *string
	EnvironmentPrefix *string
	Flags             *pflag.FlagSet
}

Config is a struct for CLI configuration.

func (*Config) Init

func (c *Config) Init() *Config

Init inits Config.