krch/org.danbrough.krch/KRootCommand

KRootCommand

open class KRootCommand(val kContext: KContext) : SuspendingCliktCommand

Constructors

constructor(kContext: KContext)

Properties

allowMultipleSubcommands

open override val allowMultipleSubcommands:

Boolean

= true

autoCompleteEnvvar

open val autoCompleteEnvvar:

String

?

val commandName:

String

val currentContext:

Context

open val helpTags:

Map

<

String

,

String

>

open val hiddenFromHelp:

Boolean

invokeWithoutSubcommand

open val invokeWithoutSubcommand:

Boolean

val kContext: KContext

List

<

String

>

printHelpOnEmptyArgs

open val printHelpOnEmptyArgs:

Boolean

treatUnknownOptionsAsArgs

open val treatUnknownOptionsAsArgs:

Boolean

Boolean

Functions

open fun aliases():

Map

<

String

,

List

<

String

>>

open fun allHelpParams():

List

<

HelpFormatter.ParameterHelp

>

open fun ~~commandHelp~~(context:

Context

):

String

commandHelpEpilog

open fun ~~commandHelpEpilog~~(context:

Context

):

String

configureContext

fun configureContext(block:

Context.Builder

.() ->

Unit

)

fun echo()

fun echo(message:

Any

?, trailingNewline:

Boolean

, err:

Boolean

)

echoFormattedHelp

fun echoFormattedHelp(error:

CliktError

?)

getFormattedHelp

fun getFormattedHelp(error:

CliktError

?):

String

?

open fun help(context:

Context

):

String

open fun helpEpilog(context:

Context

):

String

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

<

CoreSuspendingCliktCommand

>

open override fun registerOption(option:

GroupableOption

)

fun registerOption(option:

Option

)

registerOptionGroup

fun registerOptionGroup(group:

ParameterGroup

)

fun resetContext(parent:

Context

?):

Context

open suspend override fun run()

open override fun toString():

String