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

Package-level declarations

Types

Abort

class Abort : ProgramResult

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.

BaseCliktCommand

abstract class BaseCliktCommand<T : BaseCliktCommand<T>>(name: String? = null) : ParameterHolder

A base class for commands that want to define a custom type for their run function.

CliktError

open class CliktError(message: String? = null, cause: Exception? = null, val statusCode: Int = 1, val printError: Boolean = true) : RuntimeException

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

Context

class Context

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

ContextCliktError

interface ContextCliktError

An interface for CliktErrors that have a context attached

CoreCliktCommand

abstract class CoreCliktCommand(name: String? = null) : BaseCliktCommand<CoreCliktCommand>

A command with a run function that's called when the command is invoked.

CoreNoOpCliktCommand

open class CoreNoOpCliktCommand(name: String? = null) : CoreCliktCommand

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

FileNotFound

class FileNotFound(val filename: String) : UsageError

A required configuration file was not found.

GroupableOption

interface GroupableOption : StaticallyGroupedOption

An option that can be added to a ParameterGroup

IncorrectArgumentValueCount

class IncorrectArgumentValueCount(val nvalues: Int, argument: Argument) : UsageError

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

IncorrectOptionValueCount

class IncorrectOptionValueCount(minValues: Int, var paramName: String) : 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) : UsageError

A configuration file failed to parse correctly

MessageEchoer

typealias MessageEchoer = (context: Context, message: Any?, trailingNewline: Boolean, err: Boolean) -> Unit

MissingArgument

class MissingArgument(argument: Argument) : UsageError

A required argument was not provided

MissingOption

class MissingOption(option: Option) : UsageError

A required option was not provided

MultiUsageError

class MultiUsageError(val errors: List<UsageError>) : UsageError

Multiple usage errors occurred.

MutuallyExclusiveGroupException

class MutuallyExclusiveGroupException(val names: List<String>) : UsageError

Multiple mutually exclusive options were supplied.

NoSuchArgument

class NoSuchArgument(excessArguments: List<String>) : UsageError

One or more arguments were provided that do not exist.

NoSuchOption

class NoSuchOption @JvmOverloads constructor(var paramName: String, possibilities: List<String> = emptyList(), subcommand: String? = null) : UsageError

An option was provided that does not exist.

NoSuchSubcommand

class NoSuchSubcommand(var paramName: String, possibilities: List<String> = emptyList()) : UsageError

A subcommand was provided that does not exist.

ParameterHolder

interface ParameterHolder

ParameterHolderDsl

@DslMarker

annotation class ParameterHolderDsl

PrintCompletionMessage

class PrintCompletionMessage(message: String) : PrintMessage

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

PrintHelpMessage

class PrintHelpMessage(var context: Context?, val error: Boolean = false, val statusCode: Int = 0) : CliktError, ContextCliktError

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

PrintMessage

open class PrintMessage(message: String, val statusCode: Int = 0, val printError: Boolean = false) : CliktError

An exception that indicates that a message should be printed.

ProgramResult

open class ProgramResult(val statusCode: Int) : CliktError

Indicate 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(message: String?, var paramName: String? = null, val statusCode: Int = 1) : CliktError, ContextCliktError

An exception that signals a user error.

Properties

obj

var Context.obj: Any?

var Context.Builder.obj: Any?

Set an arbitrary object on the context.

Functions

context

fun <T : BaseCliktCommand<T>, U : T> U.context(block: Context.Builder.() -> Unit): U

Configure this command's Context.

findObject

inline fun <T : Any> BaseCliktCommand<*>.findObject(key: String = Context.DEFAULT_OBJ_KEY): ReadOnlyProperty<BaseCliktCommand<*>, T?>

Find the closest object of type T, or null

findOrSetObject

inline fun <T : Any> BaseCliktCommand<*>.findOrSetObject(key: String = Context.DEFAULT_OBJ_KEY, crossinline default: () -> T): ReadOnlyProperty<BaseCliktCommand<*>, T>

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

main

fun CoreCliktCommand.main(argv: Array<out String>)

fun CoreCliktCommand.main(argv: List<String>)

Parse the command line and print helpful output if any errors occur.

parse

fun CoreCliktCommand.parse(argv: Array<String>)

fun CoreCliktCommand.parse(argv: List<String>)

Parse the command line and throw an exception if parsing fails.

registerCloseable

fun <T : AutoCloseable> Context.registerCloseable(closeable: T): T

registerJvmCloseable

fun <T : AutoCloseable> Context.registerJvmCloseable(closeable: T): T

requireObject

inline fun <T : Any> BaseCliktCommand<*>.requireObject(key: String = Context.DEFAULT_OBJ_KEY): ReadOnlyProperty<BaseCliktCommand<*>, T>

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

subcommands

fun <T : BaseCliktCommand<T>, CommandT : T> CommandT.subcommands(vararg commands: T): CommandT

fun <T : BaseCliktCommand<T>, CommandT : T> CommandT.subcommands(commands: Iterable<T>): CommandT

Add the given commands as a subcommand of this command.