cmd

Documentation

Index

• Constants
• Variables
• type Result
  • func ConfigurationError(message string) Result
  • func InvalidUsage(message string) Result
  • func TaskUnavailable(message string) Result
  • func (e Result) Error() string

Constants

const (
	//ExSuccess is the exit code that signals that everything went as expected
	ExSuccess = 0
	//ExUsage is the exit code that signals that the application was not started with the correct arguments
	ExUsage = 64
	//ExUnavailable is the exit code that signals that the application failed to perform the intended task
	ExUnavailable = 69
	//ExConfig is the exit code that signals that the task failed due to a configuration error
	ExConfig = 78
)

Variables

var Success = Result{}

Success is the empty Result that is used whenever the command ran successfully

Types

type Result

type Result struct {
	ExitCode int
	Message  string
}

Result contains the final exit message and code for a CLI session

func ConfigurationError

func ConfigurationError(message string) Result

ConfigurationError returns a Result with the exit code ExConfig

func InvalidUsage

func InvalidUsage(message string) Result

InvalidUsage returns a Result with the exit code ExUsage

func TaskUnavailable

func TaskUnavailable(message string) Result

TaskUnavailable returns a Result with the exit code ExUnavailable

func (Result) Error

func (e Result) Error() string