clikt/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.

Functions

finalize

abstract fun finalize(context: Context, invocations: List<OptionParser.Invocation>)

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

metavar

abstract fun metavar(context: Context): String?

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

parameterHelp

open fun parameterHelp(context: Context): HelpFormatter.ParameterHelp.Option?

Information about this option for the help output.

postValidate

abstract fun postValidate(context: Context)

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

Properties

completionCandidates

open val completionCandidates: CompletionCandidates

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

helpTags

abstract val helpTags: Map<String, String>

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

hidden

abstract val hidden: Boolean

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

names

abstract val names: Set<String>

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

nvalues

abstract val nvalues: Int

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

optionHelp

abstract val optionHelp: String

The description of this option, usually a single line.

parser

abstract val parser: OptionParser

The parser for this option's values.

secondaryNames

abstract val secondaryNames: Set<String>

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

valueSourceKey

abstract val valueSourceKey: String?

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

Inheritors

StaticallyGroupedOption

OptionCallTransformContext

OptionTransformContext