clikt-core/com.github.ajalt.clikt.parameters.options/Option

Option

interface Option

An optional command line parameter that takes a fixed number of values.

Options can take any fixed number of values, including 0.

Inheritors

Properties

Link copied to clipboard
open val acceptsNumberValueWithoutName: Boolean

If true, this option can be specified without a name e.g. -2 instead of -o2

Link copied to clipboard
open val acceptsUnattachedValue: Boolean

If false, invocations must be of the form --foo=1 or -f1. If true, the forms --foo 1 and -f 1 are also accepted.

Link copied to clipboard
open val completionCandidates: CompletionCandidates

Optional set of strings to use when the user invokes shell autocomplete on a value for this option.

Link copied to clipboard
open val eager: Boolean

If true, the presence of this option on the command line will halt parsing immediately

Link copied to clipboard
abstract val helpTags: Map<String, String>

Extra information about this option to pass to the help formatter.

Link copied to clipboard
abstract val hidden: Boolean

If true, this option should not appear in help output.

Link copied to clipboard
abstract val names: Set<String>

The names that can be used to invoke this option. They must start with a punctuation character.

Link copied to clipboard
abstract val nvalues: IntRange

The min and max number of values that must be given to this option.

Link copied to clipboard
abstract val secondaryNames: Set<String>

Names that can be used for a secondary purpose, like disabling flag options.

Link copied to clipboard
abstract val valueSourceKey: String?

Optional explicit key to use when looking this option up from a ValueSource

Functions

Link copied to clipboard
abstract fun finalize(context: Context, invocations: List<OptionInvocation>)

Called after this command's argv is parsed to transform and store the option's value.

Link copied to clipboard
abstract fun metavar(context: Context): String?

A name representing the values for this option that can be displayed to the user.

Link copied to clipboard
abstract fun optionHelp(context: Context): String

The description of this option, usually a single line.

Link copied to clipboard
open fun parameterHelp(context: Context): HelpFormatter.ParameterHelp.Option?

Information about this option for the help output.

Link copied to clipboard
abstract fun postValidate(context: Context)

Called after all of a command's parameters have been finalized to perform validation of the final value.