cli

package

v0.0.0-...-3c0ba4a Latest Latest Go to latest Published: Oct 18, 2014 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/atsaki/lockgate

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	Bool = iota
	Bytes
	Duration
	Enum
	ExistingDir
	ExistingFile
	File
	Float
	IP
	Int
	Int64
	OpenFile
	String
	StringMap
	Strings
	TCP
	TCPList
	URL
	URLList
	Uint64
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Application ¶

type Application struct {
	Name     string
	Help     string
	Version  string
	Args     []Argument
	Flags    []Flag
	Commands []Command
	// contains filtered or unexported fields
}

func (*Application) Arg ¶

func (app *Application) Arg(arg string) *Argument

func (*Application) Command ¶

func (app *Application) Command(names []string) *Command

func (*Application) Flag ¶

func (app *Application) Flag(flag string) *Flag

func (*Application) Parse ¶

func (app *Application) Parse(args []string) (*Context, error)

func (*Application) Run ¶

func (app *Application) Run(args []string)

func (*Application) Usage ¶

func (app *Application) Usage()

type Argument ¶

type Argument struct {
	Name     string
	Help     string
	Type     int
	Required bool
	// contains filtered or unexported fields
}

func (*Argument) Bool ¶

func (arg *Argument) Bool() bool

func (*Argument) Bytes ¶

func (arg *Argument) Bytes() units.Base2Bytes

func (*Argument) Duration ¶

func (arg *Argument) Duration() time.Duration

func (*Argument) Enum ¶

func (arg *Argument) Enum() string

func (*Argument) ExistingDir ¶

func (arg *Argument) ExistingDir() string

func (*Argument) ExistingFile ¶

func (arg *Argument) ExistingFile() string

func (*Argument) File ¶

func (arg *Argument) File() *os.File

func (*Argument) Float ¶

func (arg *Argument) Float() float64

func (*Argument) IP ¶

func (arg *Argument) IP() net.IP

func (*Argument) Int ¶

func (arg *Argument) Int() int

func (*Argument) Int64 ¶

func (arg *Argument) Int64() int64

func (*Argument) OpenFile ¶

func (arg *Argument) OpenFile() *os.File

func (*Argument) String ¶

func (arg *Argument) String() string

func (*Argument) StringMap ¶

func (arg *Argument) StringMap() map[string]string

func (*Argument) Strings ¶

func (arg *Argument) Strings() []string

func (*Argument) TCP ¶

func (arg *Argument) TCP() *net.TCPAddr

func (*Argument) TCPList ¶

func (arg *Argument) TCPList() []*net.TCPAddr

func (*Argument) URL ¶

func (arg *Argument) URL() *url.URL

func (*Argument) URLList ¶

func (arg *Argument) URLList() []*url.URL

func (*Argument) Uint64 ¶

func (arg *Argument) Uint64() uint64

type Command ¶

type Command struct {
	Name     string
	Help     string
	Commands []Command
	Args     []Argument
	Flags    []Flag
	Action   func(*Context)
	// contains filtered or unexported fields
}

func (*Command) Arg ¶

func (cmd *Command) Arg(arg string) *Argument

func (*Command) Command ¶

func (cmd *Command) Command(names []string) *Command

func (*Command) Flag ¶

func (cmd *Command) Flag(flag string) *Flag

type Context ¶

type Context struct {
	App         *Application
	CommandName string
	Command     *Command
}

func (*Context) Action ¶

func (context *Context) Action()

type Flag ¶

type Flag struct {
	Name     string
	Short    byte
	Help     string
	Type     int
	Default  string
	Required bool
	// contains filtered or unexported fields
}

func (*Flag) Bool ¶

func (flag *Flag) Bool() bool

func (*Flag) Bytes ¶

func (flag *Flag) Bytes() units.Base2Bytes

func (*Flag) Duration ¶

func (flag *Flag) Duration() time.Duration

func (*Flag) Enum ¶

func (flag *Flag) Enum() string

func (*Flag) ExistingDir ¶

func (flag *Flag) ExistingDir() string

func (*Flag) ExistingFile ¶

func (flag *Flag) ExistingFile() string

func (*Flag) File ¶

func (flag *Flag) File() *os.File

func (*Flag) Float ¶

func (flag *Flag) Float() float64

func (*Flag) IP ¶

func (flag *Flag) IP() net.IP

func (*Flag) Int ¶

func (flag *Flag) Int() int

func (*Flag) Int64 ¶

func (flag *Flag) Int64() int64

func (*Flag) OpenFile ¶

func (flag *Flag) OpenFile() *os.File

func (*Flag) String ¶

func (flag *Flag) String() string

func (*Flag) StringMap ¶

func (flag *Flag) StringMap() map[string]string

func (*Flag) Strings ¶

func (flag *Flag) Strings() []string

func (*Flag) TCP ¶

func (flag *Flag) TCP() *net.TCPAddr

func (*Flag) TCPList ¶

func (flag *Flag) TCPList() []*net.TCPAddr

func (*Flag) URL ¶

func (flag *Flag) URL() *url.URL

func (*Flag) URLList ¶

func (flag *Flag) URLList() []*url.URL

func (*Flag) Uint64 ¶

func (flag *Flag) Uint64() uint64

Source Files ¶

View all Source files

cli.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL