zcli

Documentation

Index

• Variables
• func Add(name, description string, command Cmd) (cmd *cmdCont)
• func Error(format string, v ...interface{})
• func Help()
• func Parse(arg ...[]string)
• func Run(runFunc ...runFunc) (ok bool)
• func SetUnknownCommand(fn func(_ string))
• func ShowFlags(fg *flag.FlagSet)
• func ShowRequired(_ *flag.FlagSet, requiredFlags RequiredFlags)
• func Start(runFunc ...runFunc)
• type Cmd
• type RequiredFlags
• type Subcommand
• type Var
  • func SetVar(name, usage string) *Var
  • func (v *Var) Bool(def ...bool) *bool
  • func (v *Var) Int(def ...int) *int
  • func (v *Var) Required() *Var
  • func (v *Var) String(def ...string) *string

Variables

var (
	BuildTime      = ""
	BuildGoVersion = ""
	// Log cli logger
	Log            *zlog.Logger
	FirstParameter = os.Args[0]

	// appConfig      = &App{
	// Lang: defaultLang,
	// }
	Logo        string
	Description string
	Version     string
	HideHelp    bool
	HidePrompt  bool
	Lang        = defaultLang

	ShortValues = map[string]interface{}{}
)

Functions

func Add

func Add(name, description string, command Cmd) (cmd *cmdCont)

Add Registers a Cmd for the provided subCommand name

func Error

func Error(format string, v ...interface{})

func Help

func Help()

Help show help

func Parse

func Parse(arg ...[]string)

func Run

func Run(runFunc ...runFunc) (ok bool)

Run runnable

func SetUnknownCommand

func SetUnknownCommand(fn func(_ string))

func ShowFlags

func ShowFlags(fg *flag.FlagSet)

func ShowRequired

func ShowRequired(_ *flag.FlagSet, requiredFlags RequiredFlags)

func Start

func Start(runFunc ...runFunc)

Start Start

Types

type Cmd

type Cmd interface {
	Flags(subcommand *Subcommand)
	Run(args []string)
}

Cmd represents a subCommand

type RequiredFlags

type RequiredFlags []string

RequiredFlags RequiredFlags flags

type Subcommand

type Subcommand struct {
	CommandLine *flag.FlagSet
	Name        string
	Desc        string
	Supplement  string
	Parameter   string
	// contains filtered or unexported fields
}

type Var

type Var struct {
	// contains filtered or unexported fields
}

func SetVar

func SetVar(name, usage string) *Var

func (*Var) Bool

func (v *Var) Bool(def ...bool) *bool

func (*Var) Int

func (v *Var) Int(def ...int) *int

func (*Var) Required

func (v *Var) Required() *Var

Required Set flag to be required

func (*Var) String

func (v *Var) String(def ...string) *string