clikt-core/com.github.ajalt.clikt.core/Context/Builder

Builder

class Builder(command: BaseCliktCommand<*>, val parent: Context? = null)

Constructors

constructor(command: BaseCliktCommand<*>, parent: Context? = null)

Properties

allowGroupedShortOptions

var allowGroupedShortOptions: Boolean

If true, short options can be grouped together after a single -.

allowInterspersedArgs

var allowInterspersedArgs: Boolean

If false, options and arguments cannot be mixed; the first time an argument is encountered, all remaining tokens are parsed as arguments.

argumentFileReader

var ~~argumentFileReader~~: (filename: String) -> String?

autoEnvvarPrefix

var autoEnvvarPrefix: String?

The prefix to add to inferred envvar names.

correctionSuggestor

var ~~correctionSuggestor~~: TypoSuggestor

val data: MutableMap<String, Any?>

A map holding arbitrary data on the context.

var echoMessage: MessageEchoer

The function to call to echo messages when CliktCommand.echo is called.

var ~~envvarReader~~: (key: String) -> String?

var exitProcess: (status: Int) -> Unit

The function to call to exit the process with a status code.

expandArgumentFiles

var ~~expandArgumentFiles~~: Boolean

If true, arguments starting with @ will be expanded as argument files. If false, they will be treated as normal arguments.

var helpFormatter: (Context) -> HelpFormatter?

A lambda returning the help formatter for this command, or null to use the default

helpOptionNames

var helpOptionNames: Iterable<String>

The names to use for the help option.

var localization: Localization

Localized strings to use for help output and error reporting.

var Context.Builder.obj: Any?

Set an arbitrary object on the context.

val parent: Context? = null

printExtraMessages

var printExtraMessages: Boolean

Set this to false to prevent extra messages from being printed automatically.

readArgumentFile

var readArgumentFile: (filename: String) -> String?

A block that returns the content of an argument file for a given filename.

var readEnvvar: (key: String) -> String?

A function called by Clikt to get a parameter value from a given environment variable

readEnvvarBeforeValueSource

var readEnvvarBeforeValueSource: Boolean

If false,the valueSource is searched before environment variables.

suggestTypoCorrection

var suggestTypoCorrection: TypoSuggestor

A callback called when the command line contains an invalid option or subcommand name. It takes the entered name and a list of all registered names option/subcommand names and filters the list down to values to suggest to the user.

tokenTransformer

var ~~tokenTransformer~~: Context.(String) -> String

var transformToken: Context.(String) -> String

An optional transformation function that is called to transform command line

var valueSource: ValueSource?

The source that will attempt to read values for options that aren't present on the command line.

Functions

fun valueSources(vararg sources: ValueSource)

Set multiple sources that will attempt to read values for options not present on the command line.