clikt/com.github.ajalt.clikt.core

Package-level declarations

Types

Abort

class Abort(val error: Boolean = true) : RuntimeException

An internal error that signals Clikt to abort.

BadParameterValue

class BadParameterValue : UsageError

A parameter was given the correct number of values, but of invalid format or type.

CliktCommand

abstract class CliktCommand(help: String = "", epilog: String = "", name: String? = null, val invokeWithoutSubcommand: Boolean = false, val printHelpOnEmptyArgs: Boolean = false, val helpTags: Map<String, String> = emptyMap(), autoCompleteEnvvar: String? = "", allowMultipleSubcommands: Boolean = false, treatUnknownOptionsAsArgs: Boolean = false, hidden: Boolean = false) : ParameterHolder

The CliktCommand is the core of command line interfaces in Clikt.

CliktError

open class CliktError(message: String? = null, cause: Exception? = null) : RuntimeException

An exception during command line processing that should be shown to the user.

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.

FileNotFound

class FileNotFound(filename: String, var context: Context? = null) : UsageError

A required configuration file was not found.

GroupableOption

interface GroupableOption : StaticallyGroupedOption

An option that can be added to a ParameterGroup

IncorrectArgumentValueCount

class IncorrectArgumentValueCount(var argument: Argument, var context: Context? = null) : UsageError

An argument was supplied but the number of values supplied was incorrect.

IncorrectOptionValueCount

class IncorrectOptionValueCount(var option: Option, givenName: String, var context: Context? = null) : UsageError

An option was supplied but the number of values supplied to the option was incorrect.

InvalidFileFormat

class InvalidFileFormat(filename: String, message: String, lineno: Int? = null, var context: Context? = null) : UsageError

A configuration file failed to parse correctly

MissingArgument

class MissingArgument(var argument: Argument, var context: Context? = null) : UsageError

A required argument was not provided

MissingOption

class MissingOption(var option: Option, var context: Context? = null) : UsageError

A required option was not provided

MutuallyExclusiveGroupException

class MutuallyExclusiveGroupException(names: List<String>, var context: Context? = null) : UsageError

NoOpCliktCommand

open class NoOpCliktCommand(help: String = "", epilog: String = "", name: String? = null, val invokeWithoutSubcommand: Boolean = false, val printHelpOnEmptyArgs: Boolean = false, val helpTags: Map<String, String> = emptyMap(), autoCompleteEnvvar: String? = "", allowMultipleSubcommands: Boolean = false, hidden: Boolean = false) : CliktCommand

A CliktCommand that has a default implementation of CliktCommand.run that is a no-op.

NoSuchOption

class NoSuchOption(givenName: String, possibilities: List<String> = emptyList(), var context: Context? = null) : NoSuchParameter

An option was provided that does not exist.

NoSuchParameter

open class NoSuchParameter : UsageError

A parameter was provided that does not exist.

NoSuchSubcommand

class NoSuchSubcommand(givenName: String, possibilities: List<String> = emptyList(), var context: Context? = null) : NoSuchParameter

A subcommand was provided that does not exist.

ParameterHolder

interface ParameterHolder

ParameterHolderDsl

@DslMarker

annotation class ParameterHolderDsl

PrintCompletionMessage

class PrintCompletionMessage(message: String, val forceUnixLineEndings: Boolean) : PrintMessage

An exception that indicates that shell completion code should be printed.

PrintHelpMessage

class PrintHelpMessage(val command: CliktCommand, val error: Boolean = false) : CliktError

An exception that indicates that the command's help should be printed.

PrintMessage

open class PrintMessage(message: String, val error: Boolean = false) : CliktError

An exception that indicates that a message should be printed.

ProgramResult

class ProgramResult(val statusCode: Int) : CliktError

Indicate that that the program finished in a controlled manner, and should complete with the given statusCode

StaticallyGroupedOption

interface StaticallyGroupedOption : Option

TypoSuggestor

typealias TypoSuggestor = (enteredValue: String, possibleValues: List<String>) -> List<String>

UsageError

open class UsageError : CliktError

An internal exception that signals a usage error.

Functions

context

fun <T : CliktCommand> T.context(block: Context.Builder.() -> Unit): T

Configure this command's Context.

findObject

inline fun <T : Any> CliktCommand.findObject(): ReadOnlyProperty<CliktCommand, T?>

Find the closest object of type T, or null

findOrSetObject

inline fun <T : Any> CliktCommand.findOrSetObject(crossinline default: () -> T): ReadOnlyProperty<CliktCommand, T>

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

requireObject

inline fun <T : Any> CliktCommand.requireObject(): ReadOnlyProperty<CliktCommand, T>

Find the closest object of type T, or throw a NullPointerException

subcommands

fun <T : CliktCommand> T.subcommands(vararg commands: CliktCommand): T

fun <T : CliktCommand> T.subcommands(commands: Iterable<CliktCommand>): T

Add the given commands as a subcommand of this command.