abstract class CliktCommand
The CliktCommand is the core of command line interfaces in Clikt. |
|
class Context
A object used to control command line parsing and pass data between commands. |
|
open class NoRunCliktCommand : CliktCommand
A CliktCommand that has a default implementation of CliktCommand.run that is a no-op. |
class Abort : RuntimeException
An internal error that signals Clikt to abort. |
|
open class BadParameterValue : UsageError
A parameter was given the correct number of values, but of invalid format or type. |
|
open class CliktError : RuntimeException
An exception during command line processing that should be shown to the user. |
|
open class IncorrectArgumentValueCount : UsageError
An argument was supplied but the number of values supplied was incorrect. |
|
open class IncorrectOptionValueCount : UsageError
An option was supplied but the number of values supplied to the option was incorrect. |
|
open class MissingParameter : UsageError
A required parameter was not provided |
|
open class NoSuchOption : UsageError
An option was provided that does not exist. |
|
class PrintHelpMessage : CliktError
An exception that indicates that the command's help should be printed. |
|
class PrintMessage : CliktError
An exception that indicates that a message should be printed. |
|
open class UsageError : CliktError
An internal exception that signals a usage error. |
fun <T : CliktCommand> T.context(block: Builder.() -> Unit): T
Configure this command's Context. |
|
fun <T : Any> CliktCommand.findObject(): ReadOnlyProperty<CliktCommand, T?>
Find the closest object of type T, or null fun <T : Any> CliktCommand.findObject(default: () -> T): ReadOnlyProperty<CliktCommand, T>
Find the closest object of type T, setting |
|
fun <T : Any> CliktCommand.requireObject(): ReadOnlyProperty<CliktCommand, T>
Find the closest object of type T, or throw a NullPointerException |
|
fun <T : CliktCommand> T.subcommands(commands: Iterable<CliktCommand>): T fun <T : CliktCommand> T.subcommands(vararg commands: CliktCommand): T
Add the given commands as a subcommand of this command. |