Documentation
¶
Overview ¶
Package cli provides quick start for command line application
Index ¶
- Variables
- func Register(c Command)
- type Application
- type BaseCommand
- func (c *BaseCommand) Add(commands ...Command) Command
- func (c *BaseCommand) Children() []Command
- func (c *BaseCommand) EmbeddedCommand() *cobra.Command
- func (c *BaseCommand) Exec() error
- func (c *BaseCommand) Find(name string) (Command, error)
- func (c *BaseCommand) FullName() string
- func (c *BaseCommand) GetName() string
- func (c *BaseCommand) HasChild() bool
- func (c *BaseCommand) Parent() Command
- func (c *BaseCommand) Run(args []string) error
- func (c *BaseCommand) SetFullName(name string) Command
- func (c *BaseCommand) SetName(name string) Command
- func (c *BaseCommand) SetParent(p Command) Command
- type Command
- type CommandNameValue
- type TestApplication
Constants ¶
This section is empty.
Variables ¶
Functions ¶
Types ¶
type Application ¶
type Application interface {
app.Application
Root() Command
SetRoot(root Command)
}
Application cli application interface
func NewApplication ¶
func NewApplication(cmd ...Command) Application
NewApplication create new cli application
type BaseCommand ¶
func (*BaseCommand) Add ¶
func (c *BaseCommand) Add(commands ...Command) Command
func (*BaseCommand) Children ¶
func (c *BaseCommand) Children() []Command
func (*BaseCommand) EmbeddedCommand ¶
func (c *BaseCommand) EmbeddedCommand() *cobra.Command
func (*BaseCommand) Exec ¶
func (c *BaseCommand) Exec() error
func (*BaseCommand) Find ¶
func (c *BaseCommand) Find(name string) (Command, error)
func (*BaseCommand) FullName ¶
func (c *BaseCommand) FullName() string
func (*BaseCommand) GetName ¶
func (c *BaseCommand) GetName() string
func (*BaseCommand) HasChild ¶
func (c *BaseCommand) HasChild() bool
func (*BaseCommand) Parent ¶
func (c *BaseCommand) Parent() Command
func (*BaseCommand) Run ¶
func (c *BaseCommand) Run(args []string) error
func (*BaseCommand) SetFullName ¶
func (c *BaseCommand) SetFullName(name string) Command
func (*BaseCommand) SetName ¶
func (c *BaseCommand) SetName(name string) Command
func (*BaseCommand) SetParent ¶
func (c *BaseCommand) SetParent(p Command) Command
type Command ¶
type Command interface {
EmbeddedCommand() *cobra.Command
Add(commands ...Command) Command
HasChild() bool
Children() []Command
Exec() error
GetName() string
FullName() string
SetName(name string) Command
SetFullName(name string) Command
Parent() Command
SetParent(p Command) Command
Run(args []string) error
Find(name string) (Command, error)
SetOutput(output io.Writer)
SetArgs(a []string)
ExecuteC() (cmd *cobra.Command, err error)
PersistentFlags() *flag.FlagSet
}
type CommandNameValue ¶
type CommandNameValue struct {
Name string
Command interface{}
}
CommandNameValue
type TestApplication ¶
type TestApplication interface {
Application
RunTest(args ...string) (output string, err error)
}
func NewTestApplication ¶
func NewTestApplication(t *testing.T, cmd ...Command) TestApplication
Source Files
¶
- application.go
- cmdtag.go
- command.go
- flagtag.go
- properties.go
- rootcommand.go
- testapplication.go
Click to show internal directories.
Click to hide internal directories.