cli

Documentation

Overview

Package cli contains the common features used to build CLI applications.

Index

• func Execute(cmd *cobra.Command)
• func HandleErrors(f func(cmd *cobra.Command, args []string) error) func(cmd *cobra.Command, args []string)
• func NewRootCommand(programName, shortDescription string) *cobra.Command
• func PrintUserError(err error)
• type ExitCodeError
  • func (e ExitCodeError) Error() string

Functions

func Execute

func Execute(cmd *cobra.Command)

func HandleErrors

func HandleErrors(f func(cmd *cobra.Command, args []string) error) func(cmd *cobra.Command, args []string)

func NewRootCommand

func NewRootCommand(programName, shortDescription string) *cobra.Command

NewRootCommand creates a new root (base) command for a program. The caller is responsible for assigning other properties when needed.

func PrintUserError

func PrintUserError(err error)

Types

type ExitCodeError

type ExitCodeError struct {
	Message  string
	ExitCode int
}

func (ExitCodeError) Error

func (e ExitCodeError) Error() string