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

CliktCommand

abstract class CliktCommand(name: String? = null) : CoreCliktCommand

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

Command line interfaces created by creating a subclass of CliktCommand with properties defined with option and argument. You can then parse argv by calling main, which will take care of printing errors and help to the user. If you want to handle output yourself, you can use parse instead.

Once the command line has been parsed and all the parameters are populated, run is called.

Inheritors

NoOpCliktCommand

Constructors

CliktCommand

constructor(name: String? = null)

Properties

allowMultipleSubcommands

open val allowMultipleSubcommands: Boolean

autoCompleteEnvvar

open val autoCompleteEnvvar: String?

commandName

val commandName: String

currentContext

val currentContext: Context

helpTags

open val helpTags: Map<String, String>

hiddenFromHelp

open val hiddenFromHelp: Boolean

invokeWithoutSubcommand

open val invokeWithoutSubcommand: Boolean

messages

val messages: List<String>

printHelpOnEmptyArgs

open val printHelpOnEmptyArgs: Boolean

terminal

val BaseCliktCommand<*>.terminal: Terminal

A shortcut for accessing the terminal from the currentContext

treatUnknownOptionsAsArgs

open val treatUnknownOptionsAsArgs: Boolean

Functions

aliases

open fun aliases(): Map<String, List<String>>

allHelpParams

open fun allHelpParams(): List<HelpFormatter.ParameterHelp>

commandHelp

open fun ~~commandHelp~~(context: Context): String

commandHelpEpilog

open fun ~~commandHelpEpilog~~(context: Context): String

configureContext

fun configureContext(block: Context.Builder.() -> Unit)

echo

fun echo()

fun echo(message: Any?, trailingNewline: Boolean, err: Boolean)

echoFormattedHelp

fun echoFormattedHelp(error: CliktError?)

getFormattedHelp

fun getFormattedHelp(error: CliktError?): String?

help

open fun help(context: Context): String

helpEpilog

open fun helpEpilog(context: Context): String

installMordant

fun BaseCliktCommand<*>.installMordant(force: Boolean = false)

Set up this command's context to use Mordant for rendering.

issueMessage

fun issueMessage(message: String)

registerArgument

fun registerArgument(argument: Argument)

registeredArguments

fun registeredArguments(): List<Argument>

registeredOptions

fun registeredOptions(): List<Option>

registeredParameterGroups

fun registeredParameterGroups(): List<ParameterGroup>

registeredSubcommandNames

fun registeredSubcommandNames(): List<String>

registeredSubcommands

fun registeredSubcommands(): List<CoreCliktCommand>

registerOption

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

registerOptionGroup

fun registerOptionGroup(group: ParameterGroup)

resetContext

fun resetContext(parent: Context?): Context

run

abstract fun run()

test

@JvmName(name = "varargTest")

fun CliktCommand.test(vararg argv: String, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE): CliktCommandTestResult

fun CliktCommand.test(argv: String, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE): CliktCommandTestResult

fun CliktCommand.test(argv: List<String>, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE): CliktCommandTestResult

inline fun <T : BaseCliktCommand<T>> BaseCliktCommand<T>.test(argv: List<String>, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, parse: (argv: List<String>) -> Unit): CliktCommandTestResult

Test this command, returning a result that captures the output and result status code.

toString

open override fun toString(): String