UsageError

open class UsageError(message: String?, var paramName: String? = null, val statusCode: Int = 1) : CliktError, ContextCliktError

An exception that signals a user error.

Constructors

constructor(message: String, argument: Argument, statusCode: Int = 1)

constructor(message: String, option: Option, statusCode: Int = 1)

constructor(argument: Argument, statusCode: Int = 1)

constructor(option: Option, statusCode: Int = 1)

constructor(message: String?, paramName: String? = null, statusCode: Int = 1)

open override var context: Context?

The context of the command that raised this error.

The name of the parameter that caused the error.

If true, the error message should be printed to stderr.

The value to use as the exit code for the process.