cli

Documentation

Index

• type Command
  • func New(opts ...Option) *Command
  • func (c *Command) InitFlags()
  • func (c *Command) IsRoot() bool
  • func (c *Command) Option(opts ...Option) *Command
  • func (c *Command) Register(scs ...*Command) error
  • func (c *Command) Run(opts ...Option) error
• type ConfigOption
  • func WithAutoFlags(v bool) ConfigOption
  • func WithConfigChanged(f func(o, n interface{})) ConfigOption
  • func WithConfigName(names ...string) ConfigOption
• type Option
  • func Config(v interface{}) Option
  • func Description(desc string) Option
  • func Example(ex string) Option
  • func GlobalConfig(v interface{}, cfos ...ConfigOption) Option
  • func Long(desc string) Option
  • func Name(names ...string) Option
  • func PersistentPreRun(fn func(cmd *Command, args ...string)) Option
  • func PreParseConfig() Option
  • func PreRun(fn func(cmd *Command, args ...string)) Option
  • func Run(fn func(cmd *Command, args ...string)) Option
  • func SetFlags(setflag func(c *Command)) Option
  • func Short(desc string) Option
  • func Version(v string) Option

Types

type Command

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

Command is the main struct which comes from cobar

func New

func New(opts ...Option) *Command

New returns a command with options

func (*Command) InitFlags

func (c *Command) InitFlags()

InitFlags init flags from config

func (*Command) IsRoot

func (c *Command) IsRoot() bool

IsRoot check if the command is the root

func (*Command) Option

func (c *Command) Option(opts ...Option) *Command

Option merge options after new

func (*Command) Register

func (c *Command) Register(scs ...*Command) error

Register create a sub command

func (*Command) Run

func (c *Command) Run(opts ...Option) error

Run execute the whole commands

type ConfigOption

type ConfigOption func(co *configOptions)

ConfigOption defined config option for cli

func WithAutoFlags

func WithAutoFlags(v bool) ConfigOption

WithAutoFlags set auto register flags

func WithConfigChanged

func WithConfigChanged(f func(o, n interface{})) ConfigOption

WithConfigChanged set a watcher to watch the config changed params's type can be auto set with interface{}

func WithConfigName

func WithConfigName(names ...string) ConfigOption

WithConfigName set config name

type Option

type Option func(c *Command)

Option set the command with value

func Config

func Config(v interface{}) Option

Config loads configuration from provider

func Description

func Description(desc string) Option

Description returns option to set descrtiption

func Example

func Example(ex string) Option

Example returns option to set example

func GlobalConfig

func GlobalConfig(v interface{}, cfos ...ConfigOption) Option

GlobalConfig ...

func Long

func Long(desc string) Option

Long returns option to set the long

func Name

func Name(names ...string) Option

Name returns option to set use

func PersistentPreRun

func PersistentPreRun(fn func(cmd *Command, args ...string)) Option

PersistentPreRun children of this command will inherit and execute.

func PreParseConfig

func PreParseConfig() Option

PreParseConfig is a option parse config

func PreRun

func PreRun(fn func(cmd *Command, args ...string)) Option

PreRun children of this command will not inherit.

func Run

func Run(fn func(cmd *Command, args ...string)) Option

Run returns option to set the main run function

func SetFlags

func SetFlags(setflag func(c *Command)) Option

SetFlags ...

func Short

func Short(desc string) Option

Short returns option to set the short

func Version

func Version(v string) Option

Version returns option to set set the version