command

Documentation

Index

• func DefaultErrorMessage(cmd cli.NamedCommand) string
• func GlobalOptions() string
• type Command
  • func (c *Command) FlagSet(name string) *pflag.FlagSet
• type FooCommand
  • func (c *FooCommand) Help() string
  • func (c *FooCommand) Name() string
  • func (c *FooCommand) Run(ctx context.Context, args []string) int
  • func (c *FooCommand) Synopsis() string

Functions

func DefaultErrorMessage

func DefaultErrorMessage(cmd cli.NamedCommand) string

DefaultErrorMessage returns the default error message for this command

func GlobalOptions

func GlobalOptions() string

GlobalOptions returns the global usage options string.

Types

type Command

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

Command is the base command

func (*Command) FlagSet

func (c *Command) FlagSet(name string) *pflag.FlagSet

FlagSet declares flags that are common to all commands, returning a pflag.FlagSet struct that will hold their values after pflag.Parse() is called by the command.

type FooCommand

type FooCommand struct {
	UI cli.UI

	Command
}

FooCommand :

func (*FooCommand) Help

func (c *FooCommand) Help() string

Help :

func (*FooCommand) Name

func (c *FooCommand) Name() string

Name :

func (*FooCommand) Run

func (c *FooCommand) Run(ctx context.Context, args []string) int

Run :

func (*FooCommand) Synopsis

func (c *FooCommand) Synopsis() string

Synopsis :