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 Current() (interface{}, bool)
• func Error(format string, v ...interface{})
• func GetLangText(key string, def ...string) string
• func Help()
• func Input(problem string, required bool) (text string)
• func Inputln(problem string, required bool) (text string)
• func IsDoubleClickStartUp() bool
• func LaunchService(name string, description string, fn func(), config ...*daemon.Config) (daemon.ServiceIface, error)
• func LaunchServiceRun(name string, description string, fn func(), config ...*daemon.Config) error
• func Parse(arg ...[]string) (hasflag bool)
• func Run(runFunc ...runFunc) (ok bool)
• func SetLangText(lang, key, value string)
• func SetUnknownCommand(fn func(_ string))
• func SetVar(name, usage string) *v
• func SingleKillSignal() <-chan bool
• func Start(runFunc ...runFunc)
• type Cmd
• 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
	EnableDetach 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 Current

func Current() (interface{}, bool)

func Error

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

func GetLangText

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

func Help

func Help()

Help show help

func Input

func Input(problem string, required bool) (text string)

func Inputln

func Inputln(problem string, required bool) (text string)

func IsDoubleClickStartUp

func IsDoubleClickStartUp() bool

func LaunchService

func LaunchService(name string, description string, fn func(), config ...*daemon.Config) (daemon.ServiceIface, 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) (hasflag bool)

Parse Parse command line arguments

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 SingleKillSignal

func SingleKillSignal() <-chan bool

func Start

func Start(runFunc ...runFunc)

Start app

Types

type Cmd

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

Cmd represents a subCommand

type Subcommand

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

Subcommand sub command