command

Documentation

Index

• func MakeShutdownCh() <-chan struct{}
• func Map(ui cli.Ui) map[string]cli.CommandFactory
• func Register(name string, fn Factory)
• type Factory

Functions

func MakeShutdownCh

func MakeShutdownCh() <-chan struct{}

MakeShutdownCh returns a channel that can be used for shutdown notifications for commands. This channel will send a message for every interrupt or SIGTERM received.

func Map

func Map(ui cli.Ui) map[string]cli.CommandFactory

Map returns a realized mapping of available CLI commands in a format that the CLI class can consume. This should be called after all registration is complete.

func Register

func Register(name string, fn Factory)

Register adds a new CLI sub-command to the registry.

Types

type Factory

type Factory func(cli.Ui) (cli.Command, error)

Factory is a function that returns a new instance of a CLI-sub command.