krch/org.danbrough.krch/KShell

KShell

class KShell(name: String = "shell") : KCommand, CoroutineContext.Element

Constructors

constructor(name: String = "shell")

Types

object Companion

Properties

allowMultipleSubcommands

open val allowMultipleSubcommands: Boolean

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

lateinit var kContext: KContext

val CoroutineContext.kContext: KContext?

open override val key: CoroutineContext.Key<*>

val CoroutineContext.kShell: KShell?

val maxHistorySize: Int

val messages: List<String>

printHelpOnEmptyArgs

open val printHelpOnEmptyArgs: Boolean

treatUnknownOptionsAsArgs

open val treatUnknownOptionsAsArgs: Boolean

Functions

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

open fun allHelpParams(): List<

HelpFormatter.ParameterHelp

>

open fun ~~commandHelp~~(context:

Context

commandHelpEpilog

open fun ~~commandHelpEpilog~~(context:

Context

configureContext

fun configureContext(block:

Context.Builder

.() -> Unit)

fun echo()

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

echoFormattedHelp

fun echoFormattedHelp(error:

CliktError

?)

open suspend override fun execute()

open override fun <R> fold(initial: R, operation: (R, CoroutineContext.Element) -> R): R

open operator override fun <E : CoroutineContext.Element> get(key: CoroutineContext.Key<E>): E?

getFormattedHelp

fun getFormattedHelp(error:

CliktError

open override fun help(context:

Context

open fun helpEpilog(context:

Context

fun issueMessage(message: String)

open override fun minusKey(key: CoroutineContext.Key<*>): CoroutineContext

open operator fun plus(context: CoroutineContext): CoroutineContext

fun printLine(vararg args: Any?)

fun processCommand(scope:

CoroutineScope

, cmdLine: 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()

fun stop()

open override fun toString(): String