clikt

alltypes

class Abort : RuntimeException

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

typealias ArgCallsTransformer<AllT, EachT> = ArgumentTransformContext.(List<EachT>) -> AllT
typealias ArgValidator<AllT> = ArgumentTransformContext.(AllT) -> Unit
typealias ArgValueTransformer<T> = ArgumentTransformContext.(String) -> T
typealias ArgsTransformer<ValueT, EachT> = OptionCallTransformContext.(List<ValueT>) -> EachT
interface Argument

abstract fun finalize(context: Context, values: List<String>): Unit
abstract val help: String
abstract val name: String
abstract val nvalues: Int
abstract val parameterHelp: Argument?
abstract val required: Boolean

interface ArgumentDelegate<out T> : Argument, ReadOnlyProperty<CliktCommand, T>

abstract operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, T>

class ArgumentTransformContext : Argument

ArgumentTransformContext(argument: Argument, context: Context)
val argument: Argument
val context: Context
fun fail(message: String): Nothing
inline fun require(value: Boolean, lazyMessage: () -> String = { "invalid value" }): Unit

open class BadParameterValue : UsageError

BadParameterValue(text: String)
BadParameterValue(text: String, paramName: String)
BadParameterValue(text: String, argument: Argument)
BadParameterValue(text: String, option: Option)
protected open fun formatMessage(): String

typealias CallsTransformer<EachT, AllT> = OptionTransformContext.(List<EachT>) -> AllT
abstract class CliktCommand

CliktCommand(help: String = "", epilog: String = "", name: String? = null, invokeWithoutSubcommand: Boolean = false)
open fun aliases(): Map<String, List<String>>
val commandHelp: String
val commandHelpEpilog: String
val commandName: String
val context: Context
protected fun echo(message: Any?, trailingNewline: Boolean = true, err: Boolean = false): Unit
open fun getFormattedHelp(): String
open fun getFormattedUsage(): String
val invokeWithoutSubcommand: Boolean
fun main(argv: List<String>): Unit
fun main(argv: Array<String>): Unit
fun parse(argv: List<String>, parentContext: Context? = null): Unit
fun parse(argv: Array<String>, parentContext: Context? = null): Unit
fun registerArgument(argument: Argument): Unit
fun registerOption(option: Option): Unit
fun registeredSubcommandNames(): List<String>
abstract fun run(): Unit
protected fun shortHelp(): String

interface CliktConsole

abstract val lineSeparator: String
abstract fun print(text: String, error: Boolean): Unit
abstract fun promptForLine(prompt: String, hideInput: Boolean): String?

open class CliktError : RuntimeException

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

class Context

Context(parent: Context?, command: CliktCommand, allowInterspersedArgs: Boolean, autoEnvvarPrefix: String?, helpOptionNames: Set<String>, helpOptionMessage: String, helpFormatter: HelpFormatter, tokenTransformer: Context.(String) -> String, console: CliktConsole)
class Builder

Builder(command: CliktCommand, parent: Context? = null)
var allowInterspersedArgs: Boolean
var autoEnvvarPrefix: String?
var console: CliktConsole
var helpFormatter: HelpFormatter
var helpOptionMessage: String
var helpOptionNames: Set<String>
var tokenTransformer: Context.(String) -> String

val allowInterspersedArgs: Boolean
val autoEnvvarPrefix: String?
inline fun build(command: CliktCommand, parent: Context? = null, block: Builder.() -> Unit): Context
val command: CliktCommand
val console: CliktConsole
fun fail(message: String = ""): Nothing
inline fun <reified T> findObject(): T?
inline fun <reified T> findObject(defaultValue: () -> T): T
fun findRoot(): Context
val helpFormatter: HelpFormatter
val helpOptionMessage: String
val helpOptionNames: Set<String>
var invokedSubcommand: CliktCommand?
var obj: Any?
val parent: Context?
val tokenTransformer: Context.(String) -> String

class EagerOption : Option

EagerOption(vararg names: String, nvalues: Int = 0, help: String = "", hidden: Boolean = false, callback: OptionTransformContext.() -> Unit)
EagerOption(names: Set<String>, nvalues: Int, help: String, hidden: Boolean, callback: OptionTransformContext.() -> Unit)
fun finalize(context: Context, invocations: List<Invocation>): Unit
val help: String
val hidden: Boolean
val metavar: String?
val names: Set<String>
val nvalues: Int
val parser: OptionParser
val secondaryNames: Set<String>

class FlagOption<T> : OptionDelegate<T>

FlagOption(names: Set<String>, secondaryNames: Set<String>, help: String, hidden: Boolean, envvar: String?, transformEnvvar: OptionTransformContext.(String) -> T, transformAll: CallsTransformer<String, T>)
val envvar: String?
fun finalize(context: Context, invocations: List<Invocation>): Unit
fun getValue(thisRef: CliktCommand, property: KProperty<*>): T
val help: String
val hidden: Boolean
val metavar: String?
var names: Set<String>
val nvalues: Int
val parser: FlagOptionParser
operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, T>
val secondaryNames: Set<String>
val transformAll: CallsTransformer<String, T>
val transformEnvvar: OptionTransformContext.(String) -> T

object FlagOptionParser : OptionParser

fun parseLongOpt(option: Option, name: String, argv: List<String>, index: Int, explicitValue: String?): ParseResult
fun parseShortOpt(option: Option, name: String, argv: List<String>, index: Int, optionIndex: Int): ParseResult

interface HelpFormatter

sealed class ParameterHelp

data class Argument : ParameterHelp

Argument(name: String, help: String, required: Boolean, repeatable: Boolean)
val help: String
val name: String
val repeatable: Boolean
val required: Boolean

data class Option : ParameterHelp

Option(names: Set<String>, secondaryNames: Set<String>, metavar: String?, help: String, nvalues: Int)
val help: String
val metavar: String?
val names: Set<String>
val nvalues: Int
val secondaryNames: Set<String>

data class Subcommand : ParameterHelp

Subcommand(name: String, help: String)
val help: String
val name: String

abstract fun formatHelp(prolog: String, epilog: String, parameters: List<ParameterHelp>, programName: String = ""): String
abstract fun formatUsage(parameters: List<ParameterHelp>, programName: String = ""): String

open class IncorrectArgumentValueCount : UsageError

IncorrectArgumentValueCount(argument: Argument)
protected open fun formatMessage(): String

open class IncorrectOptionValueCount : UsageError

IncorrectOptionValueCount(option: Option, givenName: String)
protected open fun formatMessage(): String

class InteractiveCliktConsole : CliktConsole

InteractiveCliktConsole(console: Console)
val lineSeparator: String
fun print(text: String, error: Boolean): Unit
fun promptForLine(prompt: String, hideInput: Boolean): String?

open class MissingParameter : UsageError

MissingParameter(paramName: String, paramType: String = "parameter")
MissingParameter(argument: Argument)
MissingParameter(option: Option)
protected open fun formatMessage(): String

open class NoRunCliktCommand : CliktCommand

NoRunCliktCommand(help: String = "", epilog: String = "", name: String? = null)
open fun run(): Unit

open class NoSuchOption : UsageError

NoSuchOption(givenName: String, possibilities: List<String> = emptyList())
protected open fun formatMessage(): String
protected val givenName: String
protected val possibilities: List<String>

class NonInteractiveCliktConsole : CliktConsole

NonInteractiveCliktConsole()
val lineSeparator: String
fun print(text: String, error: Boolean): Unit
fun promptForLine(prompt: String, hideInput: Boolean): String

typealias NullableOption<EachT, ValueT> = OptionWithValues<EachT?, EachT, ValueT>
interface Option

abstract fun finalize(context: Context, invocations: List<Invocation>): Unit
abstract val help: String
abstract val hidden: Boolean
abstract val metavar: String?
abstract val names: Set<String>
abstract val nvalues: Int
open val parameterHelp: Option?
abstract val parser: OptionParser
abstract val secondaryNames: Set<String>

class OptionCallTransformContext : Option

OptionCallTransformContext(name: String, option: Option, context: Context)
val context: Context
fun fail(message: String): Nothing
val name: String
val option: Option
inline fun require(value: Boolean, lazyMessage: () -> String = { "invalid value" }): Unit

interface OptionDelegate<out T> : Option, ReadOnlyProperty<CliktCommand, T>

abstract operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, T>

interface OptionParser

data class Invocation

Invocation(name: String, values: List<String>)
val name: String
val values: List<String>

data class ParseResult

ParseResult(consumedCount: Int, name: String, values: List<String>)
ParseResult(consumedCount: Int, invocation: Invocation)
val consumedCount: Int
val invocation: Invocation

abstract fun parseLongOpt(option: Option, name: String, argv: List<String>, index: Int, explicitValue: String?): ParseResult
abstract fun parseShortOpt(option: Option, name: String, argv: List<String>, index: Int, optionIndex: Int): ParseResult

class OptionTransformContext : Option

OptionTransformContext(option: Option, context: Context)
val context: Context
fun fail(message: String): Nothing
val option: Option
inline fun require(value: Boolean, lazyMessage: () -> String = { "invalid value" }): Unit

typealias OptionValidator<AllT> = OptionTransformContext.(AllT) -> Unit
class OptionWithValues<AllT, EachT, ValueT> : OptionDelegate<AllT>

OptionWithValues(names: Set<String>, metavarExplicit: String?, metavarDefault: String?, nvalues: Int, help: String, hidden: Boolean, envvar: String?, envvarSplit: Regex, parser: OptionWithValuesParser, transformValue: ValueTransformer<ValueT>, transformEach: ArgsTransformer<ValueT, EachT>, transformAll: CallsTransformer<EachT, AllT>)
fun <AllT, EachT, ValueT> copy(transformValue: ValueTransformer<ValueT>, transformEach: ArgsTransformer<ValueT, EachT>, transformAll: CallsTransformer<EachT, AllT>, names: Set<String> = this.names, metavarExplicit: String? = this.metavarExplicit, metavarDefault: String? = this.metavarDefault, nvalues: Int = this.nvalues, help: String = this.help, hidden: Boolean = this.hidden, envvar: String? = this.envvar, envvarSplit: Regex = this.envvarSplit, parser: OptionWithValuesParser = this.parser): OptionWithValues<AllT, EachT, ValueT>
val envvar: String?
val envvarSplit: Regex
fun finalize(context: Context, invocations: List<Invocation>): Unit
fun getValue(thisRef: CliktCommand, property: KProperty<*>): AllT
val help: String
val hidden: Boolean
val metavar: String?
val metavarDefault: String?
val metavarExplicit: String?
var names: Set<String>
val nvalues: Int
val parser: OptionWithValuesParser
operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, AllT>
val secondaryNames: Set<String>
val transformAll: CallsTransformer<EachT, AllT>
val transformEach: ArgsTransformer<ValueT, EachT>
val transformValue: ValueTransformer<ValueT>

object OptionWithValuesParser : OptionParser

fun parseLongOpt(option: Option, name: String, argv: List<String>, index: Int, explicitValue: String?): ParseResult
fun parseShortOpt(option: Option, name: String, argv: List<String>, index: Int, optionIndex: Int): ParseResult

open class PlaintextHelpFormatter : HelpFormatter

PlaintextHelpFormatter(indent: String = " ", width: Int? = null, maxWidth: Int = 78, maxColWidth: Int? = null, usageTitle: String = "Usage:", optionsTitle: String = "Options:", argumentsTitle: String = "Arguments:", commandsTitle: String = "Commands:", optionsMetavar: String = "[OPTIONS]", commandMetavar: String = "COMMAND [ARGS]...", colSpacing: Int = 2)
protected open fun StringBuilder.addArguments(parameters: List<ParameterHelp>): Unit
protected open fun StringBuilder.addCommands(parameters: List<ParameterHelp>): Unit
protected open fun StringBuilder.addEpilog(epilog: String): Unit
protected open fun StringBuilder.addOptions(parameters: List<ParameterHelp>): Unit
protected open fun StringBuilder.addProlog(prolog: String): Unit
protected open fun StringBuilder.addUsage(parameters: List<ParameterHelp>, programName: String): Unit
protected fun StringBuilder.appendDefinitionList(rows: List<Pair<String, String>>): Unit
protected val argumentsTitle: String
protected val colSpacing: Int
protected val commandMetavar: String
protected val commandsTitle: String
open fun formatHelp(prolog: String, epilog: String, parameters: List<ParameterHelp>, programName: String): String
open fun formatUsage(parameters: List<ParameterHelp>, programName: String): String
protected val indent: String
protected open fun joinOptionNames(names: Set<String>): String
protected val maxColWidth: Int
protected open fun optionMetavar(option: Option): String
protected val optionsMetavar: String
protected val optionsTitle: String
protected val usageTitle: String
protected val width: Int

class PrintHelpMessage : CliktError

PrintHelpMessage(command: CliktCommand)
val command: CliktCommand

class PrintMessage : CliktError

PrintMessage(message: String)

class ProcessedArgument<AllT, ValueT> : ArgumentDelegate<AllT>

ProcessedArgument(name: String, nvalues: Int, required: Boolean, help: String, transformValue: ArgValueTransformer<ValueT>, transformAll: ArgCallsTransformer<AllT, ValueT>)
fun <AllT, ValueT> copy(transformValue: ArgValueTransformer<ValueT>, transformAll: ArgCallsTransformer<AllT, ValueT>, name: String = this.name, nvalues: Int = this.nvalues, required: Boolean = this.required, help: String = this.help): ProcessedArgument<AllT, ValueT>
fun finalize(context: Context, values: List<String>): Unit
fun getValue(thisRef: CliktCommand, property: KProperty<*>): AllT
val help: String
var name: String
val nvalues: Int
val parameterHelp: Argument
operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, AllT>
val required: Boolean
val transformAll: ArgCallsTransformer<AllT, ValueT>
val transformValue: ArgValueTransformer<ValueT>

typealias RawOption = NullableOption<String, String>
object TermUi

fun confirm(text: String, default: Boolean = false, abort: Boolean = false, promptSuffix: String = ": ", showDefault: Boolean = true, console: CliktConsole = defaultCliktConsole()): Boolean?
fun echo(message: Any?, trailingNewline: Boolean = true, err: Boolean = false, console: CliktConsole = defaultCliktConsole()): Unit
fun editFile(filename: String, editor: String? = null, env: Map<String, String> = emptyMap(), requireSave: Boolean = false, extension: String = ".txt"): Unit
fun editText(text: String, editor: String? = null, env: Map<String, String> = emptyMap(), requireSave: Boolean = false, extension: String = ".txt"): String?
val isWindows: Boolean
fun <T> prompt(text: String, default: String? = null, hideInput: Boolean = false, requireConfirmation: Boolean = false, confirmationPrompt: String = "Repeat for confirmation: ", promptSuffix: String = ": ", showDefault: Boolean = true, console: CliktConsole = defaultCliktConsole(), convert: (String) -> T): T?
fun prompt(text: String, default: String? = null, hideInput: Boolean = false, requireConfirmation: Boolean = false, confirmationPrompt: String = "Repeat for confirmation: ", promptSuffix: String = ": ", showDefault: Boolean = true): String?

open class UsageError : CliktError

UsageError(text: String, paramName: String? = null)
UsageError(text: String, argument: Argument)
UsageError(text: String, option: Option)
var argument: Argument?
protected open fun formatMessage(): String
fun helpMessage(context: Context? = null): String
protected fun inferParamName(): String
open val message: String?
var option: Option?
var paramName: String?
val text: String?

typealias ValueTransformer<ValueT> = OptionCallTransformContext.(String) -> ValueT

package com.github.ajalt.clikt.core

class Abort : RuntimeException

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

open class BadParameterValue : UsageError

BadParameterValue(text: String)
BadParameterValue(text: String, paramName: String)
BadParameterValue(text: String, argument: Argument)
BadParameterValue(text: String, option: Option)
protected open fun formatMessage(): String

abstract class CliktCommand

CliktCommand(help: String = "", epilog: String = "", name: String? = null, invokeWithoutSubcommand: Boolean = false)
open fun aliases(): Map<String, List<String>>
val commandHelp: String
val commandHelpEpilog: String
val commandName: String
val context: Context
protected fun echo(message: Any?, trailingNewline: Boolean = true, err: Boolean = false): Unit
open fun getFormattedHelp(): String
open fun getFormattedUsage(): String
val invokeWithoutSubcommand: Boolean
fun main(argv: List<String>): Unit
fun main(argv: Array<String>): Unit
fun parse(argv: List<String>, parentContext: Context? = null): Unit
fun parse(argv: Array<String>, parentContext: Context? = null): Unit
fun registerArgument(argument: Argument): Unit
fun registerOption(option: Option): Unit
fun registeredSubcommandNames(): List<String>
abstract fun run(): Unit
protected fun shortHelp(): String

open class CliktError : RuntimeException

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

class Context

Context(parent: Context?, command: CliktCommand, allowInterspersedArgs: Boolean, autoEnvvarPrefix: String?, helpOptionNames: Set<String>, helpOptionMessage: String, helpFormatter: HelpFormatter, tokenTransformer: Context.(String) -> String, console: CliktConsole)
class Builder

Builder(command: CliktCommand, parent: Context? = null)
var allowInterspersedArgs: Boolean
var autoEnvvarPrefix: String?
var console: CliktConsole
var helpFormatter: HelpFormatter
var helpOptionMessage: String
var helpOptionNames: Set<String>
var tokenTransformer: Context.(String) -> String

val allowInterspersedArgs: Boolean
val autoEnvvarPrefix: String?
inline fun build(command: CliktCommand, parent: Context? = null, block: Builder.() -> Unit): Context
val command: CliktCommand
val console: CliktConsole
fun fail(message: String = ""): Nothing
inline fun <reified T> findObject(): T?
inline fun <reified T> findObject(defaultValue: () -> T): T
fun findRoot(): Context
val helpFormatter: HelpFormatter
val helpOptionMessage: String
val helpOptionNames: Set<String>
var invokedSubcommand: CliktCommand?
var obj: Any?
val parent: Context?
val tokenTransformer: Context.(String) -> String

open class IncorrectArgumentValueCount : UsageError

IncorrectArgumentValueCount(argument: Argument)
protected open fun formatMessage(): String

open class IncorrectOptionValueCount : UsageError

IncorrectOptionValueCount(option: Option, givenName: String)
protected open fun formatMessage(): String

open class MissingParameter : UsageError

MissingParameter(paramName: String, paramType: String = "parameter")
MissingParameter(argument: Argument)
MissingParameter(option: Option)
protected open fun formatMessage(): String

open class NoRunCliktCommand : CliktCommand

NoRunCliktCommand(help: String = "", epilog: String = "", name: String? = null)
open fun run(): Unit

open class NoSuchOption : UsageError

NoSuchOption(givenName: String, possibilities: List<String> = emptyList())
protected open fun formatMessage(): String
protected val givenName: String
protected val possibilities: List<String>

class PrintHelpMessage : CliktError

PrintHelpMessage(command: CliktCommand)
val command: CliktCommand

class PrintMessage : CliktError

PrintMessage(message: String)

open class UsageError : CliktError

UsageError(text: String, paramName: String? = null)
UsageError(text: String, argument: Argument)
UsageError(text: String, option: Option)
var argument: Argument?
protected open fun formatMessage(): String
fun helpMessage(context: Context? = null): String
protected fun inferParamName(): String
open val message: String?
var option: Option?
var paramName: String?
val text: String?

fun <T : CliktCommand> T.context(block: Builder.() -> Unit): T
inline fun <reified T : Any> CliktCommand.findObject(): ReadOnlyProperty<CliktCommand, T?>
inline fun <reified T : Any> CliktCommand.findObject(crossinline default: () -> T): ReadOnlyProperty<CliktCommand, T>
inline fun <reified T : Any> CliktCommand.requireObject(): ReadOnlyProperty<CliktCommand, T>
fun <T : CliktCommand> T.subcommands(commands: Iterable<CliktCommand>): T
fun <T : CliktCommand> T.subcommands(vararg commands: CliktCommand): T

package com.github.ajalt.clikt.output

interface CliktConsole

abstract val lineSeparator: String
abstract fun print(text: String, error: Boolean): Unit
abstract fun promptForLine(prompt: String, hideInput: Boolean): String?

interface HelpFormatter

sealed class ParameterHelp

data class Argument : ParameterHelp

Argument(name: String, help: String, required: Boolean, repeatable: Boolean)
val help: String
val name: String
val repeatable: Boolean
val required: Boolean

data class Option : ParameterHelp

Option(names: Set<String>, secondaryNames: Set<String>, metavar: String?, help: String, nvalues: Int)
val help: String
val metavar: String?
val names: Set<String>
val nvalues: Int
val secondaryNames: Set<String>

data class Subcommand : ParameterHelp

Subcommand(name: String, help: String)
val help: String
val name: String

abstract fun formatHelp(prolog: String, epilog: String, parameters: List<ParameterHelp>, programName: String = ""): String
abstract fun formatUsage(parameters: List<ParameterHelp>, programName: String = ""): String

class InteractiveCliktConsole : CliktConsole

InteractiveCliktConsole(console: Console)
val lineSeparator: String
fun print(text: String, error: Boolean): Unit
fun promptForLine(prompt: String, hideInput: Boolean): String?

class NonInteractiveCliktConsole : CliktConsole

NonInteractiveCliktConsole()
val lineSeparator: String
fun print(text: String, error: Boolean): Unit
fun promptForLine(prompt: String, hideInput: Boolean): String

open class PlaintextHelpFormatter : HelpFormatter

PlaintextHelpFormatter(indent: String = " ", width: Int? = null, maxWidth: Int = 78, maxColWidth: Int? = null, usageTitle: String = "Usage:", optionsTitle: String = "Options:", argumentsTitle: String = "Arguments:", commandsTitle: String = "Commands:", optionsMetavar: String = "[OPTIONS]", commandMetavar: String = "COMMAND [ARGS]...", colSpacing: Int = 2)
protected open fun StringBuilder.addArguments(parameters: List<ParameterHelp>): Unit
protected open fun StringBuilder.addCommands(parameters: List<ParameterHelp>): Unit
protected open fun StringBuilder.addEpilog(epilog: String): Unit
protected open fun StringBuilder.addOptions(parameters: List<ParameterHelp>): Unit
protected open fun StringBuilder.addProlog(prolog: String): Unit
protected open fun StringBuilder.addUsage(parameters: List<ParameterHelp>, programName: String): Unit
protected fun StringBuilder.appendDefinitionList(rows: List<Pair<String, String>>): Unit
protected val argumentsTitle: String
protected val colSpacing: Int
protected val commandMetavar: String
protected val commandsTitle: String
open fun formatHelp(prolog: String, epilog: String, parameters: List<ParameterHelp>, programName: String): String
open fun formatUsage(parameters: List<ParameterHelp>, programName: String): String
protected val indent: String
protected open fun joinOptionNames(names: Set<String>): String
protected val maxColWidth: Int
protected open fun optionMetavar(option: Option): String
protected val optionsMetavar: String
protected val optionsTitle: String
protected val usageTitle: String
protected val width: Int

object TermUi

fun confirm(text: String, default: Boolean = false, abort: Boolean = false, promptSuffix: String = ": ", showDefault: Boolean = true, console: CliktConsole = defaultCliktConsole()): Boolean?
fun echo(message: Any?, trailingNewline: Boolean = true, err: Boolean = false, console: CliktConsole = defaultCliktConsole()): Unit
fun editFile(filename: String, editor: String? = null, env: Map<String, String> = emptyMap(), requireSave: Boolean = false, extension: String = ".txt"): Unit
fun editText(text: String, editor: String? = null, env: Map<String, String> = emptyMap(), requireSave: Boolean = false, extension: String = ".txt"): String?
val isWindows: Boolean
fun <T> prompt(text: String, default: String? = null, hideInput: Boolean = false, requireConfirmation: Boolean = false, confirmationPrompt: String = "Repeat for confirmation: ", promptSuffix: String = ": ", showDefault: Boolean = true, console: CliktConsole = defaultCliktConsole(), convert: (String) -> T): T?
fun prompt(text: String, default: String? = null, hideInput: Boolean = false, requireConfirmation: Boolean = false, confirmationPrompt: String = "Repeat for confirmation: ", promptSuffix: String = ": ", showDefault: Boolean = true): String?

fun defaultCliktConsole(): CliktConsole

package com.github.ajalt.clikt.parameters.arguments

typealias ArgCallsTransformer<AllT, EachT> = ArgumentTransformContext.(List<EachT>) -> AllT
typealias ArgValidator<AllT> = ArgumentTransformContext.(AllT) -> Unit
typealias ArgValueTransformer<T> = ArgumentTransformContext.(String) -> T
interface Argument

abstract fun finalize(context: Context, values: List<String>): Unit
abstract val help: String
abstract val name: String
abstract val nvalues: Int
abstract val parameterHelp: Argument?
abstract val required: Boolean

interface ArgumentDelegate<out T> : Argument, ReadOnlyProperty<CliktCommand, T>

abstract operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, T>

class ArgumentTransformContext : Argument

ArgumentTransformContext(argument: Argument, context: Context)
val argument: Argument
val context: Context
fun fail(message: String): Nothing
inline fun require(value: Boolean, lazyMessage: () -> String = { "invalid value" }): Unit

class ProcessedArgument<AllT, ValueT> : ArgumentDelegate<AllT>

ProcessedArgument(name: String, nvalues: Int, required: Boolean, help: String, transformValue: ArgValueTransformer<ValueT>, transformAll: ArgCallsTransformer<AllT, ValueT>)
fun <AllT, ValueT> copy(transformValue: ArgValueTransformer<ValueT>, transformAll: ArgCallsTransformer<AllT, ValueT>, name: String = this.name, nvalues: Int = this.nvalues, required: Boolean = this.required, help: String = this.help): ProcessedArgument<AllT, ValueT>
fun finalize(context: Context, values: List<String>): Unit
fun getValue(thisRef: CliktCommand, property: KProperty<*>): AllT
val help: String
var name: String
val nvalues: Int
val parameterHelp: Argument
operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, AllT>
val required: Boolean
val transformAll: ArgCallsTransformer<AllT, ValueT>
val transformValue: ArgValueTransformer<ValueT>

fun CliktCommand.argument(name: String = "", help: String = ""): RawArgument
inline fun <T : Any> RawArgument.convert(crossinline conversion: ArgValueTransformer<T>): ProcessedArgument<T, T>
fun <T : Any> ProcessedArgument<T, T>.default(value: T): ArgumentDelegate<T>
inline fun <T : Any> ProcessedArgument<T, T>.defaultLazy(crossinline value: () -> T): ArgumentDelegate<T>
fun <T : Any> ProcessedArgument<T, T>.multiple(required: Boolean = false): ProcessedArgument<List<T>, T>
fun <AllT : Any, ValueT> ProcessedArgument<AllT, ValueT>.optional(): ProcessedArgument<AllT?, ValueT>
fun <T : Any> ProcessedArgument<T, T>.pair(): ProcessedArgument<Pair<T, T>, T>
fun <AllInT, ValueT, AllOutT> ProcessedArgument<AllInT, ValueT>.transformAll(nvalues: Int? = null, required: Boolean? = null, transform: ArgCallsTransformer<AllOutT, ValueT>): ProcessedArgument<AllOutT, ValueT>
fun <T : Any> ProcessedArgument<T, T>.triple(): ProcessedArgument<Triple<T, T, T>, T>
fun <T : Any> ProcessedArgument<List<T>, T>.unique(): ProcessedArgument<Set<T>, T>
fun <AllT : Any, ValueT> ProcessedArgument<AllT, ValueT>.validate(validator: ArgValidator<AllT>): ArgumentDelegate<AllT>

package com.github.ajalt.clikt.parameters.options

typealias ArgsTransformer<ValueT, EachT> = OptionCallTransformContext.(List<ValueT>) -> EachT
typealias CallsTransformer<EachT, AllT> = OptionTransformContext.(List<EachT>) -> AllT
class EagerOption : Option

EagerOption(vararg names: String, nvalues: Int = 0, help: String = "", hidden: Boolean = false, callback: OptionTransformContext.() -> Unit)
EagerOption(names: Set<String>, nvalues: Int, help: String, hidden: Boolean, callback: OptionTransformContext.() -> Unit)
fun finalize(context: Context, invocations: List<Invocation>): Unit
val help: String
val hidden: Boolean
val metavar: String?
val names: Set<String>
val nvalues: Int
val parser: OptionParser
val secondaryNames: Set<String>

class FlagOption<T> : OptionDelegate<T>

FlagOption(names: Set<String>, secondaryNames: Set<String>, help: String, hidden: Boolean, envvar: String?, transformEnvvar: OptionTransformContext.(String) -> T, transformAll: CallsTransformer<String, T>)
val envvar: String?
fun finalize(context: Context, invocations: List<Invocation>): Unit
fun getValue(thisRef: CliktCommand, property: KProperty<*>): T
val help: String
val hidden: Boolean
val metavar: String?
var names: Set<String>
val nvalues: Int
val parser: FlagOptionParser
operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, T>
val secondaryNames: Set<String>
val transformAll: CallsTransformer<String, T>
val transformEnvvar: OptionTransformContext.(String) -> T

typealias NullableOption<EachT, ValueT> = OptionWithValues<EachT?, EachT, ValueT>
interface Option

abstract fun finalize(context: Context, invocations: List<Invocation>): Unit
abstract val help: String
abstract val hidden: Boolean
abstract val metavar: String?
abstract val names: Set<String>
abstract val nvalues: Int
open val parameterHelp: Option?
abstract val parser: OptionParser
abstract val secondaryNames: Set<String>

class OptionCallTransformContext : Option

OptionCallTransformContext(name: String, option: Option, context: Context)
val context: Context
fun fail(message: String): Nothing
val name: String
val option: Option
inline fun require(value: Boolean, lazyMessage: () -> String = { "invalid value" }): Unit

interface OptionDelegate<out T> : Option, ReadOnlyProperty<CliktCommand, T>

abstract operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, T>

class OptionTransformContext : Option

OptionTransformContext(option: Option, context: Context)
val context: Context
fun fail(message: String): Nothing
val option: Option
inline fun require(value: Boolean, lazyMessage: () -> String = { "invalid value" }): Unit

typealias OptionValidator<AllT> = OptionTransformContext.(AllT) -> Unit
class OptionWithValues<AllT, EachT, ValueT> : OptionDelegate<AllT>

OptionWithValues(names: Set<String>, metavarExplicit: String?, metavarDefault: String?, nvalues: Int, help: String, hidden: Boolean, envvar: String?, envvarSplit: Regex, parser: OptionWithValuesParser, transformValue: ValueTransformer<ValueT>, transformEach: ArgsTransformer<ValueT, EachT>, transformAll: CallsTransformer<EachT, AllT>)
fun <AllT, EachT, ValueT> copy(transformValue: ValueTransformer<ValueT>, transformEach: ArgsTransformer<ValueT, EachT>, transformAll: CallsTransformer<EachT, AllT>, names: Set<String> = this.names, metavarExplicit: String? = this.metavarExplicit, metavarDefault: String? = this.metavarDefault, nvalues: Int = this.nvalues, help: String = this.help, hidden: Boolean = this.hidden, envvar: String? = this.envvar, envvarSplit: Regex = this.envvarSplit, parser: OptionWithValuesParser = this.parser): OptionWithValues<AllT, EachT, ValueT>
val envvar: String?
val envvarSplit: Regex
fun finalize(context: Context, invocations: List<Invocation>): Unit
fun getValue(thisRef: CliktCommand, property: KProperty<*>): AllT
val help: String
val hidden: Boolean
val metavar: String?
val metavarDefault: String?
val metavarExplicit: String?
var names: Set<String>
val nvalues: Int
val parser: OptionWithValuesParser
operator fun provideDelegate(thisRef: CliktCommand, prop: KProperty<*>): ReadOnlyProperty<CliktCommand, AllT>
val secondaryNames: Set<String>
val transformAll: CallsTransformer<EachT, AllT>
val transformEach: ArgsTransformer<ValueT, EachT>
val transformValue: ValueTransformer<ValueT>

typealias RawOption = NullableOption<String, String>
typealias ValueTransformer<ValueT> = OptionCallTransformContext.(String) -> ValueT
inline fun <T : Any> RawOption.convert(metavar: String = "VALUE", envvarSplit: Regex = this.envvarSplit, crossinline conversion: ValueTransformer<T>): NullableOption<T, T>
fun RawOption.counted(): FlagOption<Int>
fun <T : Any> FlagOption<T?>.default(value: T): FlagOption<T>
fun <EachT : Any, ValueT> NullableOption<EachT, ValueT>.default(value: EachT): OptionWithValues<EachT, EachT, ValueT>
inline fun <EachT : Any, ValueT> NullableOption<EachT, ValueT>.defaultLazy(crossinline value: () -> EachT): OptionWithValues<EachT, EachT, ValueT>
fun RawOption.flag(vararg secondaryNames: String, default: Boolean = false): FlagOption<Boolean>
fun <EachT : Any, ValueT> NullableOption<EachT, ValueT>.multiple(default: List<EachT> = emptyList()): OptionWithValues<List<EachT>, EachT, ValueT>
fun CliktCommand.option(vararg names: String, help: String = "", metavar: String? = null, hidden: Boolean = false, envvar: String? = null): RawOption
fun <EachT : Any, ValueT> NullableOption<EachT, ValueT>.pair(): NullableOption<Pair<ValueT, ValueT>, ValueT>
fun <T : Any> NullableOption<T, T>.prompt(text: String? = null, default: String? = null, hideInput: Boolean = false, requireConfirmation: Boolean = false, confirmationPrompt: String = "Repeat for confirmation: ", promptSuffix: String = ": ", showDefault: Boolean = true): OptionWithValues<T, T, T>
fun <EachT : Any, ValueT> NullableOption<EachT, ValueT>.required(): OptionWithValues<EachT, EachT, ValueT>
fun <T : Any> RawOption.switch(choices: Map<String, T>): FlagOption<T?>
fun <T : Any> RawOption.switch(vararg choices: Pair<String, T>): FlagOption<T?>
fun <AllT, EachT : Any, ValueT> NullableOption<EachT, ValueT>.transformAll(transform: CallsTransformer<EachT, AllT>): OptionWithValues<AllT, EachT, ValueT>
fun <EachInT : Any, EachOutT : Any, ValueT> NullableOption<EachInT, ValueT>.transformValues(nvalues: Int, transform: ArgsTransformer<ValueT, EachOutT>): NullableOption<EachOutT, ValueT>
fun <EachT : Any, ValueT> NullableOption<EachT, ValueT>.triple(): NullableOption<Triple<ValueT, ValueT, ValueT>, ValueT>
fun <EachT : Any, ValueT> OptionWithValues<List<EachT>, EachT, ValueT>.unique(): OptionWithValues<Set<EachT>, EachT, ValueT>
fun <T : Any> FlagOption<T>.validate(validator: OptionValidator<T>): OptionDelegate<T>
fun <AllT : Any, EachT, ValueT> OptionWithValues<AllT, EachT, ValueT>.validate(validator: OptionValidator<AllT>): OptionDelegate<AllT>
inline fun <T : CliktCommand> T.versionOption(version: String, help: String = "Show the version and exit.", names: Set<String> = setOf("--version"), crossinline message: (String) -> String = { "$commandName version $it" }): T

package com.github.ajalt.clikt.parameters.types

fun <T : Any> RawArgument.choice(choices: Map<String, T>): ProcessedArgument<T, T>
fun <T : Any> RawArgument.choice(vararg choices: Pair<String, T>): ProcessedArgument<T, T>
fun RawArgument.choice(vararg choices: String): ProcessedArgument<String, String>
fun <T : Any> RawOption.choice(choices: Map<String, T>, metavar: String = mvar(choices.keys)): NullableOption<T, T>
fun <T : Any> RawOption.choice(vararg choices: Pair<String, T>, metavar: String = mvar(choices.map { it.first })): NullableOption<T, T>
fun RawOption.choice(vararg choices: String, metavar: String = mvar(choices.asIterable())): NullableOption<String, String>
fun RawArgument.double(): ProcessedArgument<Double, Double>
fun RawOption.double(): NullableOption<Double, Double>
fun RawArgument.file(exists: Boolean = false, fileOkay: Boolean = true, folderOkay: Boolean = true, writable: Boolean = false, readable: Boolean = false): ProcessedArgument<File, File>
fun RawOption.file(exists: Boolean = false, fileOkay: Boolean = true, folderOkay: Boolean = true, writable: Boolean = false, readable: Boolean = false): NullableOption<File, File>
fun RawArgument.float(): ProcessedArgument<Float, Float>
fun RawOption.float(): NullableOption<Float, Float>
fun RawArgument.int(): ProcessedArgument<Int, Int>
fun RawOption.int(): NullableOption<Int, Int>
fun RawArgument.long(): ProcessedArgument<Long, Long>
fun RawOption.long(): NullableOption<Long, Long>
fun RawArgument.path(exists: Boolean = false, fileOkay: Boolean = true, folderOkay: Boolean = true, writable: Boolean = false, readable: Boolean = false, fileSystem: FileSystem = FileSystems.getDefault()): ProcessedArgument<Path, Path>
fun RawOption.path(exists: Boolean = false, fileOkay: Boolean = true, folderOkay: Boolean = true, writable: Boolean = false, readable: Boolean = false, fileSystem: FileSystem = java.nio.file.FileSystems.getDefault()): NullableOption<Path, Path>
fun <T> ProcessedArgument<T, T>.restrictTo(min: T? = null, max: T? = null, clamp: Boolean = false): ProcessedArgument<T, T> where T : Number, T : Comparable<T>
fun <T> ProcessedArgument<T, T>.restrictTo(range: ClosedRange<T>, clamp: Boolean = false): ProcessedArgument<T, T> where T : Number, T : Comparable<T>
fun <T> OptionWithValues<T?, T, T>.restrictTo(min: T? = null, max: T? = null, clamp: Boolean = false): OptionWithValues<T?, T, T> where T : Number, T : Comparable<T>
fun <T> OptionWithValues<T?, T, T>.restrictTo(range: ClosedRange<T>, clamp: Boolean = false): OptionWithValues<T?, T, T> where T : Number, T : Comparable<T>

package com.github.ajalt.clikt.parsers

object FlagOptionParser : OptionParser

fun parseLongOpt(option: Option, name: String, argv: List<String>, index: Int, explicitValue: String?): ParseResult
fun parseShortOpt(option: Option, name: String, argv: List<String>, index: Int, optionIndex: Int): ParseResult

interface OptionParser

data class Invocation

Invocation(name: String, values: List<String>)
val name: String
val values: List<String>

data class ParseResult

ParseResult(consumedCount: Int, name: String, values: List<String>)
ParseResult(consumedCount: Int, invocation: Invocation)
val consumedCount: Int
val invocation: Invocation

abstract fun parseLongOpt(option: Option, name: String, argv: List<String>, index: Int, explicitValue: String?): ParseResult
abstract fun parseShortOpt(option: Option, name: String, argv: List<String>, index: Int, optionIndex: Int): ParseResult

object OptionWithValuesParser : OptionParser

fun parseLongOpt(option: Option, name: String, argv: List<String>, index: Int, explicitValue: String?): ParseResult
fun parseShortOpt(option: Option, name: String, argv: List<String>, index: Int, optionIndex: Int): ParseResult