plugcmd

type Aliaser ¶

type Aliaser interface {
	plugins.Plugin
	CmdAliases() []string
}

Aliaser is a command that provides aliases for itself

type AliaserFn ¶

type AliaserFn func() []string

AliaserFn is a function that can be used to implement the Aliaser interface

func (fn AliaserFn) CmdAliases() []string

func (fn AliaserFn) PluginName() string

type Commander ¶

type Commander interface {
	plugins.Plugin
	Main(ctx context.Context, root string, args []string) error
}

Commander is a plugin that is meant to be the beginning of a CLI application

func Find(name string, plugs plugins.Plugins) Commander

func FindFromArgs(args []string, plugs plugins.Plugins) Commander

type CommanderFn ¶

type CommanderFn func(ctx context.Context, root string, args []string) error

CommanderFn is a function that can be used to implement the Commander interface

func (fn CommanderFn) Main(ctx context.Context, root string, args []string) error

func (fn CommanderFn) PluginName() string

type Describer ¶

type Describer interface {
	plugins.Plugin
	Description() string
}

Describer is called by `Print` and can be implemented to print a short, single line, description of the plugin. `-h`

type DescriberFn ¶

type DescriberFn func() string

DescriberFn is a function that can be used to implement the Describer interface

func (fn DescriberFn) Description() string

func (fn DescriberFn) PluginName() string

type FlagPrinter ¶

type FlagPrinter interface {
	plugins.Plugin
	PrintFlags(w io.Writer) error
}

type FlagPrinterFn ¶

type FlagPrinterFn func(w io.Writer) error

FlagPrinterFn is a function that can be used to implement the FlagPrinter interface

func (fn FlagPrinterFn) PluginName() string

func (fn FlagPrinterFn) PrintFlags(w io.Writer) error

type Flagger ¶

type Flagger interface {
	plugins.Plugin
	Flags() (*flag.FlagSet, error)
}

type FlaggerFn ¶

type FlaggerFn func() (*flag.FlagSet, error)

FlaggerFn is a function that can be used to implement the Flagger interface

func (fn FlaggerFn) Flags() (*flag.FlagSet, error)

func (fn FlaggerFn) PluginName() string

type NamedCommander ¶

type NamedCommander interface {
	Commander
	Namer
}

type Namer ¶

type Namer interface {
	plugins.Plugin
	CmdName() string
}

Namer is a command that provides a different name for the command than the name of the Plugin

type NamerFn ¶

type NamerFn func() string

NamerFn is a function that can be used to implement the Namer interface

func (fn NamerFn) CmdName() string

func (fn NamerFn) PluginName() string

type SubCommander ¶

type SubCommander interface {
	plugins.Plugin
	SubCommands() []Commander
}

SubCommander can be implemented to provide a list of plugins.Plugin that can be used as sub-commands of the current Plugin

type SubCommanderFn ¶

type SubCommanderFn func() []Commander

SubCommanderFn is a function that can be used to implement the SubCommander interface

func (fn SubCommanderFn) PluginName() string

func (fn SubCommanderFn) SubCommands() []Commander

type UsagePrinter ¶

type UsagePrinter interface {
	plugins.Plugin
	PrintUsage(w io.Writer) error
}

UsagePrinter is called by `Print` and can be implemented to print a large block of usage information after the `Describer` interface is called. This is useful for printing flag information, links, and other messages to users.

type UsagePrinterFn ¶

type UsagePrinterFn func(w io.Writer) error

UsagePrinterFn is a function that can be used to implement the UsagePrinter interface

func (fn UsagePrinterFn) PluginName() string

func (fn UsagePrinterFn) PrintUsage(w io.Writer) error