cli

Documentation

Index

• Constants
• func NewManifestCLIModule(etcdClient *etcd.Client) *admincli.GenericCLIModule
• type ManifestCommand
  • func (mc *ManifestCommand) Children() []admincli.CLIModule
  • func (mc *ManifestCommand) Hint() string
  • func (mc *ManifestCommand) Name() string
  • func (mc *ManifestCommand) Run(ctx context.Context, output io.Writer, args ...string) (argsOk bool)
  • func (mc *ManifestCommand) Runnable() bool
  • func (mc *ManifestCommand) Usage() string

Constants

const AllTagSymbol = "<ALL STREAMS>"

AllTagSymbol is the symbol that is used to denote the streams accessible with the "all" tag.

Functions

func NewManifestCLIModule

func NewManifestCLIModule(etcdClient *etcd.Client) *admincli.GenericCLIModule

NewMrPlotterCLIModule returns a new instance of MrPlotterCLIModule.

Types

type ManifestCommand

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

ManifestCommand encapsulates a CLI command.

func (*ManifestCommand) Children

func (mc *ManifestCommand) Children() []admincli.CLIModule

Children return nil.

func (*ManifestCommand) Hint

func (mc *ManifestCommand) Hint() string

Hint returns a short help text string for the command.

func (*ManifestCommand) Name

func (mc *ManifestCommand) Name() string

Name returns the name of the command.

func (*ManifestCommand) Run

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

Run executes the CLI command encapsulated by this ManifestCommand.

func (*ManifestCommand) Runnable

func (mc *ManifestCommand) Runnable() bool

Runnable returns true, as MrPlotterCommand encapsulates a CLI command.

func (*ManifestCommand) Usage

func (mc *ManifestCommand) Usage() string

Usage returns a longer help text string for the command.