Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cliapp

package module

Go to main page

Versions in this module

v1

v1.2.0

Dec 8, 2018

Changes in this version

type App

+ Description string

+ Hooks map[string]appHookFunc

+ Logo Logo

+ Name string

+ Strict bool

+ Version string

+ func Instance() *App

+ func (app *App) Add(c *Command, more ...*Command)

+ func (app *App) AddAliases(command string, names []string)

+ func (app *App) AddCommand(c *Command) *Command

+ func (app *App) AddError(err error)

+ func (app *App) AddVar(name, value string)

+ func (app *App) AddVars(vars map[string]string)

+ func (app *App) CommandName() string

+ func (app *App) CommandNames() []string

+ func (app *App) Commands() map[string]*Command

+ func (app *App) Config(fn func(a *App))

+ func (app *App) DebugMode()

+ func (app *App) DefaultCommand(name string)

+ func (app *App) Exec(name string, args []string) int

+ func (app *App) GetVar(name string) string

+ func (app *App) GetVars(name string, value string) map[string]string

+ func (app *App) Initialize()

+ func (app *App) IsCommand(name string) bool

+ func (app *App) NewCommand(name, useFor string, config func(c *Command)) *Command

+ func (app *App) On(name string, handler func(a *App, data interface{}))

+ func (app *App) QuietMode()

+ func (app *App) RealCommandName(alias string) string

+ func (app *App) Run()

+ func (app *App) SetLogo(logo string, style ...string)

+ func (app *App) SetVerbose(verbose uint)

type Argument

+ func (a *Argument) HasValue() bool

type CmdLine

+ func (c *CmdLine) ArgLine() string

type Command

+ func NewCommand(name, useFor string, config func(c *Command)) *Command

+ func (c *Command) AttachTo(app *App)

+ func (c *Command) Run(inArgs []string) int

+ func (c *Command) SetFunc(fn CmdFunc) *Command

v1.1.4

Sep 7, 2018

v1.1.3

Aug 28, 2018

v1.1.2

Aug 28, 2018

Changes in this version

+ const VerbCrazy

type Argument

+ ShowName string

type Command

+ Config func(c *Command)

+ UseFor string

v1.1.1

Aug 20, 2018

Changes in this version

+ const ERR

+ const EvtAfter

+ const EvtBefore

+ const EvtError

+ const EvtInit

+ const HelpVar

+ const OK

+ const VerbDebug

+ const VerbError

+ const VerbInfo

+ const VerbQuiet

+ const VerbWarn

+ var CLI = &CmdLine

+ func AllCommands() map[string]*Command

+ func Exit(code int)

+ func Logf(level uint, format string, v ...interface{})

+ func Print(args ...interface{}) (int, error)

+ func Printf(format string, args ...interface{}) (int, error)

+ func Println(args ...interface{}) (int, error)

+ func Verbose() uint

+ type Application struct

+ Description string

+ Hooks map[string]appHookFunc

+ Logo Logo

+ Name string

+ Strict bool

+ Version string

+ func App() *Application

+ func New(fn ...func(a *Application)) *Application

+ func NewApp(fn ...func(a *Application)) *Application

+ func (app *Application) Add(c *Command, more ...*Command)

+ func (app *Application) AddAliases(command string, names []string)

+ func (app *Application) AddError(err error)

+ func (app *Application) AddVar(name string, value string)

+ func (app *Application) AddVars(vars map[string]string)

+ func (app *Application) CommandName() string

+ func (app *Application) CommandNames() []string

+ func (app *Application) Commands() map[string]*Command

+ func (app *Application) DebugMode()

+ func (app *Application) DefaultCommand(name string)

+ func (app *Application) GetVar(name string) string

+ func (app *Application) GetVars(name string, value string) map[string]string

+ func (app *Application) Initialize()

+ func (app *Application) IsCommand(name string) bool

+ func (app *Application) On(name string, handler func(a *Application, data interface{}))

+ func (app *Application) QuietMode()

+ func (app *Application) RealCommandName(alias string) string

+ func (app *Application) Run()

+ func (app *Application) SetLogo(logo string, style ...string)

+ func (app *Application) SetVerbose(verbose uint)

+ func (app *Application) SubRun(name string, args []string) int

+ type Argument struct

+ Description string

+ IsArray bool

+ Name string

+ Required bool

+ Value interface{}

+ func (a *Argument) Array() (ss []string)

+ func (a *Argument) Int(defVal ...int) int

+ func (a *Argument) String(defVal ...string) string

+ func (a *Argument) Strings() (ss []string)

+ type Booleans []bool

+ func (s *Booleans) Set(value bool) error

+ func (s *Booleans) String() string

+ type CmdFunc func(cmd *Command, args []string) int

+ func (f CmdFunc) Run(cmd *Command, args []string) int

+ type CmdLine struct

+ func (c *CmdLine) ArgsString() string

+ func (c *CmdLine) BinName() string

+ func (c *CmdLine) OsName() string

+ func (c *CmdLine) PID() int

+ func (c *CmdLine) WorkDir() string

+ type Command struct

+ Aliases []string

+ CustomFlags bool

+ Description string

+ Examples string

+ Flags flag.FlagSet

+ Func CmdFunc

+ Help string

+ Hooks map[string]HookFunc

+ Name string

+ Vars map[string]string

+ func (c *Command) AddArg(name, description string, requiredAndIsArray ...bool) *Argument

+ func (c *Command) AddVars(vars map[string]string)

+ func (c *Command) AliasesString(sep ...string) string

+ func (c *Command) AloneRun() int

+ func (c *Command) App() *Application

+ func (c *Command) Arg(name string) *Argument

+ func (c *Command) ArgByIndex(i int) *Argument

+ func (c *Command) Args() []*Argument

+ func (c *Command) BoolOpt(p *bool, name string, short string, defValue bool, description string) *Command

+ func (c *Command) Copy() *Command

+ func (c *Command) Disable()

+ func (c *Command) Error() error

+ func (c *Command) Errorf(format string, v ...interface{}) int

+ func (c *Command) Execute(args []string) int

+ func (c *Command) GetVar(name string) string

+ func (c *Command) Init() *Command

+ func (c *Command) IntOpt(p *int, name string, short string, defValue int, description string) *Command

+ func (c *Command) IsAlone() bool

+ func (c *Command) IsDisabled() bool

+ func (c *Command) Logf(level uint, format string, v ...interface{})

+ func (c *Command) NotAlone() bool

+ func (c *Command) On(name string, handler func(c *Command, data interface{}))

+ func (c *Command) OptDes(name string) string

+ func (c *Command) OptFlag(name string) *flag.Flag

+ func (c *Command) OptNames() map[string]string

+ func (c *Command) ParseDefaults() string

+ func (c *Command) RawArg(i int) string

+ func (c *Command) RawArgs() []string

+ func (c *Command) Runnable() bool

+ func (c *Command) ShortName(name string) string

+ func (c *Command) ShowHelp(quit ...bool)

+ func (c *Command) StrOpt(p *string, name string, short string, defValue string, description string) *Command

+ func (c *Command) UintOpt(p *uint, name string, short string, defValue uint, description string) *Command

+ func (c *Command) VarOpt(p flag.Value, name string, short string, description string) *Command

+ func (c *Command) WithError(err error) int

+ type GlobalOpts struct

+ type HookFunc func(cmd *Command, data interface{})

+ type Ints []int

+ func (s *Ints) Set(value int) error

+ func (s *Ints) String() string

+ type Logo struct

+ Style string

+ Text string

+ type Option struct

+ DType string

+ DefValue interface{}

+ Description string

+ Name string

+ Required bool

+ Short string

+ VarPtr interface{}

+ type Runner interface

+ Run func(cmd *Command, args []string) int

+ type Strings []string

+ func (s *Strings) Set(value string) error

+ func (s *Strings) String() string