cli

Documentation

Index

• Constants
• func AddConfigFlags(cmd *cobra.Command, serviceAddress string)
• func CaptureOutput(capture io.Writer)
• func GetConfigCommand() *cobra.Command
• func GetConnection(cmd *cobra.Command) (*grpc.ClientConn, error)
• func GetOutput() io.Writer
• func InitConfig(configNameInit string)
• func NewContextWithAuthHeaderFromFlag(ctx context.Context, authHeaderFlag *pflag.Flag) context.Context
• func Output(msg string, args ...interface{})

Constants

const (

	// AuthHeaderFlag - the flag name
	AuthHeaderFlag = "auth-header"

	// Authorization the header keyword
	Authorization = "authorization"
)

const (
	// ExitSuccess means nominal status
	ExitSuccess = iota

	// ExitError means general error
	ExitError

	// ExitBadConnection means failed connection to remote service
	ExitBadConnection

	// ExitBadArgs means invalid argument values were given
	ExitBadArgs = 128
)

Functions

func AddConfigFlags

func AddConfigFlags(cmd *cobra.Command, serviceAddress string)

AddConfigFlags :

func CaptureOutput

func CaptureOutput(capture io.Writer)

CaptureOutput allows a test harness to redirect output to an alternate source for testing

func GetConfigCommand

func GetConfigCommand() *cobra.Command

GetConfigCommand :

func GetConnection

func GetConnection(cmd *cobra.Command) (*grpc.ClientConn, error)

GetConnection returns a gRPC client connection to the onos service

func GetOutput

func GetOutput() io.Writer

GetOutput returns the current output writer

func InitConfig

func InitConfig(configNameInit string)

InitConfig :

func NewContextWithAuthHeaderFromFlag

func NewContextWithAuthHeaderFromFlag(ctx context.Context, authHeaderFlag *pflag.Flag) context.Context

NewContextWithAuthHeaderFromFlag - use from the CLI with --auth-header flag

func Output

func Output(msg string, args ...interface{})

Output prints the specified format message with arguments to stdout.