Context

class 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)

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

common

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)

Types

Builder

common

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

Companion

common

object Companion

Functions

commandNameWithParents

common

fun commandNameWithParents(): List<String>

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

fail

common

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

Throw a UsageError with the given message

findObject

common

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

Find the closest object of type T

findOrSetObject

common

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

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

findRoot

common

fun findRoot(): Context

Find the outermost context

parentNames

common

fun parentNames(): List<String>

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

Properties

allowInterspersedArgs

common

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

common

val autoEnvvarPrefix: String?

The prefix to add to inferred envvar names.

command

common

val command: CliktCommand

The command that this context associated with.

console

common

val console: CliktConsole

The console to use to print messages.

correctionSuggestor

common

val correctionSuggestor: TypoSuggestor

A callback called when the command line contains an invalid option or subcommand name.

expandArgumentFiles

common

val expandArgumentFiles: Boolean

If true, arguments starting with @ will be expanded as argument files.

helpFormatter

common

val helpFormatter: HelpFormatter

The help formatter for this command.

helpOptionNames

common

val helpOptionNames: Set<String>

The names to use for the help option.

invokedSubcommand

common

var invokedSubcommand: CliktCommand? = null

localization

common

val localization: Localization

obj

common

var obj: Any? = null

parent

common

val parent: Context?

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

printExtraMessages

common

val printExtraMessages: Boolean

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

readEnvvarBeforeValueSource

common

val readEnvvarBeforeValueSource: Boolean

tokenTransformer

common

val tokenTransformer: Context.(String) -> String

An optional transformation function that is called to transform command line tokens (options and commands) before parsing.

valueSource

common

val valueSource: ValueSource?