zcli

Documentation

Overview

Package zcli quickly build cli applications

Index

• Variables
• func Add(name, description string, command Cmd) *cmdCont
• func CheckErr(err error, exit ...bool)
• func Error(format string, v ...interface{})
• func GetLangText(key string, def ...string) string
• func GetParentProcessName() (string, error)
• func Help()
• func IsDoubleClickStartUp() bool
• func LaunchService(name string, description string, fn func(), config ...*daemon.Config) (daemon.ServiceIfe, error)
• func LaunchServiceRun(name string, description string, fn func(), config ...*daemon.Config) error
• func Parse(arg ...[]string)
• func Run(runFunc ...runFunc) (ok bool)
• func SetLangText(lang, key, value string)
• func SetUnknownCommand(fn func(_ string))
• func SetVar(name, usage string) *v
• func ShowFlags(fg *flag.FlagSet)
• func ShowRequired(_ *flag.FlagSet, requiredFlags RequiredFlags)
• func Start(runFunc ...runFunc)
• type Cmd
• type RequiredFlags
• type Subcommand

Variables

var (
	// BuildTime Build Time
	BuildTime = ""
	// BuildGoVersion Build Go Version
	BuildGoVersion = ""
	// BuildGitCommitID Build Git CommitID
	BuildGitCommitID = ""
	// Log cli logger
	Log *zlog.Logger
	// FirstParameter First Parameter
	FirstParameter = os.Args[0]

	Logo       string
	Name       string
	Version    string
	HideHelp   bool
	HidePrompt bool
	Lang       = defaultLang

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

Functions

func Add

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

Add registers a cmd for the provided subCommand name

func CheckErr

func CheckErr(err error, exit ...bool)

func Error

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

func GetLangText

func GetLangText(key string, def ...string) string

func GetParentProcessName

func GetParentProcessName() (string, error)

func Help

func Help()

Help show help

func IsDoubleClickStartUp

func IsDoubleClickStartUp() bool

func LaunchService

func LaunchService(name string, description string, fn func(), config ...*daemon.Config) (daemon.ServiceIfe, error)

LaunchService Launch Service

func LaunchServiceRun

func LaunchServiceRun(name string, description string, fn func(), config ...*daemon.Config) error

LaunchServiceRun Launch Service and run

func Parse

func Parse(arg ...[]string)

Parse Parse

func Run

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

Run runnable

func SetLangText

func SetLangText(lang, key, value string)

func SetUnknownCommand

func SetUnknownCommand(fn func(_ string))

SetUnknownCommand set unknown command handle

func SetVar

func SetVar(name, usage string) *v

func ShowFlags

func ShowFlags(fg *flag.FlagSet)

ShowFlags ShowFlags

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
}

Subcommand sub command