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

Context

class Context @JvmOverloads constructor(val parent: Context?, val command: CliktCommand, val allowInterspersedArgs: Boolean, val autoEnvvarPrefix: String?, val printExtraMessages: Boolean, val helpOptionNames: Set<String>, val helpFormatter: HelpFormatter, val tokenTransformer: Context.(String) -> String, val console: CliktConsole, val expandArgumentFiles: Boolean, val readEnvvarBeforeValueSource: Boolean, val valueSource: ValueSource?, val correctionSuggestor: TypoSuggestor, val localization: Localization, val readEnvvar: (String) -> String? = ::readEnvvar, val originalArgv: List<String> = emptyList())

A object used to control command line parsing and pass data between commands.

A new Context instance is created for each command each time the command line is parsed.

Constructors

Context

@JvmOverloads

fun Context(parent: Context?, command: CliktCommand, allowInterspersedArgs: Boolean, autoEnvvarPrefix: String?, printExtraMessages: Boolean, helpOptionNames: Set<String>, helpFormatter: HelpFormatter, tokenTransformer: Context.(String) -> String, console: CliktConsole, expandArgumentFiles: Boolean, readEnvvarBeforeValueSource: Boolean, valueSource: ValueSource?, correctionSuggestor: TypoSuggestor, localization: Localization, readEnvvar: (String) -> String? = ::readEnvvar, originalArgv: List<String> = emptyList())

Types

Builder

class Builder(command: CliktCommand, parent: Context? = null)

Companion

object Companion

Functions

commandNameWithParents

fun commandNameWithParents(): List<String>

Return a list of command names, starting with the topmost command and ending with this Context's command.

fail

fun fail(message: String = ""): Nothing

Throw a UsageError with the given message

findObject

inline fun <T : Any> findObject(): T?

Find the closest object of type T

findOrSetObject

inline fun <T : Any> findOrSetObject(defaultValue: () -> T): T

Find the closest object of type T, setting this.obj if one is not found.

findRoot

fun findRoot(): Context

Find the outermost context

parentNames

fun parentNames(): List<String>

Return a list of command names, starting with the topmost command and ending with this Context's parent.

Properties

allowInterspersedArgs

val allowInterspersedArgs: Boolean

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

autoEnvvarPrefix

val autoEnvvarPrefix: String?

The prefix to add to inferred envvar names. If null, the prefix is based on the parent's prefix, if there is one. If no command specifies, a prefix, envvar lookup is disabled.

command

val command: CliktCommand

The command that this context associated with.

console

val console: CliktConsole

The console to use to print messages.

correctionSuggestor

val correctionSuggestor: 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.

expandArgumentFiles

val expandArgumentFiles: Boolean

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

helpFormatter

val helpFormatter: HelpFormatter

The help formatter for this command.

helpOptionNames

val helpOptionNames: Set<String>

The names to use for the help option. If any names in the set conflict with other options, the conflicting name will not be used for the help option. If the set is empty, or contains no unique names, no help option will be added.

invokedSubcommand

var invokedSubcommand: CliktCommand? = null

localization

val localization: Localization

obj

var obj: Any? = null

originalArgv

val originalArgv: List<String>

parent

val parent: Context?

If this context is the child of another command, parent is the parent command's context.

printExtraMessages

val printExtraMessages: Boolean

Set this to false to prevent extra messages from being printed automatically. You can still access them at CliktCommand.messages inside of CliktCommand.run.

readEnvvar

val readEnvvar: (String) -> String?

readEnvvarBeforeValueSource

val readEnvvarBeforeValueSource: Boolean

tokenTransformer

val tokenTransformer: Context.(String) -> String

An optional transformation function that is called to transform command line tokens (options and commands) before parsing. This can be used to implement e.g. case insensitive behavior.

valueSource

val valueSource: ValueSource?