cmd

Documentation

Index

• Variables
• func Info(i *cmd.Info) *cmd.Info
• func IsPiped(ctx *cmd.Context) bool
• func IsUserAbortedError(err error) bool
• func NewSuperCommand(p cmd.SuperCommandParams) *cmd.SuperCommand
• func UserConfirmName(verificationName string, objectType string, ctx *cmd.Context) error
• func UserConfirmYes(ctx *cmd.Context) error

Variables

var DefaultLog = &cmd.Log{
	DefaultConfig: os.Getenv(osenv.JujuLoggingConfigEnvKey),
}

DefaultLog is the default command logging implementation.

Functions

func Info

func Info(i *cmd.Info) *cmd.Info

func IsPiped

func IsPiped(ctx *cmd.Context) bool

IsPiped determines if the command was used in a pipe and, hence, it's stdin is not usable for user input.

func IsUserAbortedError

func IsUserAbortedError(err error) bool

IsUserAbortedError returns true if err is of type userAbortedError.

func NewSuperCommand

func NewSuperCommand(p cmd.SuperCommandParams) *cmd.SuperCommand

NewSuperCommand is like cmd.NewSuperCommand but it adds juju-specific functionality: - The default logging configuration is taken from the environment; - The version is configured to the current juju version; - The additional version information is sourced from juju/juju/version; - The command emits a log message when a command runs.

func UserConfirmName

func UserConfirmName(verificationName string, objectType string, ctx *cmd.Context) error

UserConfirmName returns an error if we do not read a "name" of the model/controller/etc from user input.

func UserConfirmYes

func UserConfirmYes(ctx *cmd.Context) error

UserConfirmYes returns an error if we do not read a "y" or "yes" from user input.