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

Package-level declarations

Types

CoreChainedCliktCommand

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

A version of CoreCliktCommand that returns a value from the run function, which is then passed to subcommands.

CoreSuspendingCliktCommand

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

A version of CoreCliktCommand that supports a suspending run function.

CoreSuspendingNoOpCliktCommand

abstract class CoreSuspendingNoOpCliktCommand(name: String? = null) : CoreSuspendingCliktCommand

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

Functions

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

suspend fun CoreSuspendingCliktCommand.main(argv: List<String>)

fun <T> CoreChainedCliktCommand<T>.main(argv: Array<out String>, initial: T): T

fun <T> CoreChainedCliktCommand<T>.main(argv: List<String>, initial: T): T

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

suspend fun CoreSuspendingCliktCommand.parse(argv: Array<String>)

suspend fun CoreSuspendingCliktCommand.parse(argv: List<String>)

fun <T> CoreChainedCliktCommand<T>.parse(argv: Array<String>, initial: T): T

fun <T> CoreChainedCliktCommand<T>.parse(argv: List<String>, initial: T): T

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