cli

Documentation

Index

• Constants
• func Execute()
• func ExitWithError(code int, err error)
• func ExitWithErrorMessage(msg string, args ...interface{})
• func ExitWithOutput(msg string, output ...interface{})
• func ExitWithSuccess()
• func GenerateCliDocs()
• func GetRootCommand() *cobra.Command
• func Output(msg string, args ...interface{})

Constants

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 Execute

func Execute()

Execute runs the root command and any sub-commands.

func ExitWithError

func ExitWithError(code int, err error)

ExitWithError prints the specified error and exits program with the given error code.

func ExitWithErrorMessage

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

ExitWithErrorMessage prints the specified message and exits program with the given error code.

func ExitWithOutput

func ExitWithOutput(msg string, output ...interface{})

ExitWithOutput prints the specified entity and exits program with success.

func ExitWithSuccess

func ExitWithSuccess()

ExitWithSuccess exits program with success without any output.

func GenerateCliDocs

func GenerateCliDocs()

GenerateCliDocs generate markdown files for onos-cli commands

func GetRootCommand

func GetRootCommand() *cobra.Command

GetRootCommand returns the root onos command

func Output

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

Output prints the specified format message with arguments to stdout.