cli-common/hu.bme.mit.semantifyr.cli.common/RootCommand

RootCommand

abstract class RootCommand(name: String, description: String, subcommands: List<SuspendingCliktCommand>) : SuspendingCliktCommand

Constructors

RootCommand

constructor(name: String, description: String, subcommands: List<SuspendingCliktCommand>)

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

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?)

execute

suspend fun SuspendingCliktCommand.execute(arguments: List<String>)

getFormattedHelp

fun getFormattedHelp(error: CliktError?): String?

help

open override fun help(context: Context): String

helpEpilog

open fun helpEpilog(context: Context): String

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<CoreSuspendingCliktCommand>

registerOption

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

registerOptionGroup

fun registerOptionGroup(group: ParameterGroup)

resetContext

fun resetContext(parent: Context?): Context

run

open suspend override fun run()

toString

open override fun toString(): String

verifyCase

suspend fun SuspendingCliktCommand.verifyCase(output: VerifyOutput, caseName: String, verify: suspend () -> CaseOutcome): ExitCode

verifyOutputOption

fun SuspendingCliktCommand.verifyOutputOption(): MutuallyExclusiveOptions<VerifyOutput, VerifyOutput>