cli

Documentation

Index

• type MrPlotterCLIModule
  • func NewMrPlotterCLIModule(ecl *etcd.Client) *MrPlotterCLIModule
  • func (mpcli *MrPlotterCLIModule) Children() []admincli.CLIModule
  • func (mpcli *MrPlotterCLIModule) Hint() string
  • func (mpcli *MrPlotterCLIModule) Name() string
  • func (mpcli *MrPlotterCLIModule) Run(ctx context.Context, output io.Writer, args ...string) (argsOk bool)
  • func (mpcli *MrPlotterCLIModule) Runnable() bool
  • func (mpcli *MrPlotterCLIModule) Usage() string
• type MrPlotterCommand
  • func (mpc *MrPlotterCommand) Children() []admincli.CLIModule
  • func (mpc *MrPlotterCommand) Hint() string
  • func (mpc *MrPlotterCommand) Name() string
  • func (mpc *MrPlotterCommand) Run(ctx context.Context, output io.Writer, args ...string) (argsOk bool)
  • func (mpc *MrPlotterCommand) Runnable() bool
  • func (mpc *MrPlotterCommand) Usage() string

Types

type MrPlotterCLIModule

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

MrPlotterCLIModule encapsulates the CLI module for configuring Mr. Plotter.

func NewMrPlotterCLIModule

func NewMrPlotterCLIModule(ecl *etcd.Client) *MrPlotterCLIModule

NewMrPlotterCLIModule returns a new instance of MrPlotterCLIModule.

func (*MrPlotterCLIModule) Children

func (mpcli *MrPlotterCLIModule) Children() []admincli.CLIModule

Children returns the CLI functions for the Mr. Plotter CLI module.

func (*MrPlotterCLIModule) Hint

func (mpcli *MrPlotterCLIModule) Hint() string

Hint prints the hint string for the Mr. Plotter CLI Module.

func (*MrPlotterCLIModule) Name

func (mpcli *MrPlotterCLIModule) Name() string

Name returns "mrplotter"

func (*MrPlotterCLIModule) Run

func (mpcli *MrPlotterCLIModule) Run(ctx context.Context, output io.Writer, args ...string) (argsOk bool)

Run does nothing and returns false.

func (*MrPlotterCLIModule) Runnable

func (mpcli *MrPlotterCLIModule) Runnable() bool

Runnable returns false.

func (*MrPlotterCLIModule) Usage

func (mpcli *MrPlotterCLIModule) Usage() string

Usage returns the usage string for the Mr. Plotter CLI Module.

type MrPlotterCommand

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

MrPlotterCommand encapsulates a CLI command.

func (*MrPlotterCommand) Children

func (mpc *MrPlotterCommand) Children() []admincli.CLIModule

Children return nil.

func (*MrPlotterCommand) Hint

func (mpc *MrPlotterCommand) Hint() string

Hint returns a short help text string for the command.

func (*MrPlotterCommand) Name

func (mpc *MrPlotterCommand) Name() string

Name returns the name of the command.

func (*MrPlotterCommand) Run

func (mpc *MrPlotterCommand) Run(ctx context.Context, output io.Writer, args ...string) (argsOk bool)

Run executes the CLI command encapsulated by this MrPlotterCommand.

func (*MrPlotterCommand) Runnable

func (mpc *MrPlotterCommand) Runnable() bool

Runnable returns true, as MrPlotterCommand encapsulates a CLI command.

func (*MrPlotterCommand) Usage

func (mpc *MrPlotterCommand) Usage() string

Usage returns a longer help text string for the command.