1.12.0

quarkdown-cli/com.quarkdown.cli/QuarkdownCommand

QuarkdownCommand

class QuarkdownCommand : CliktCommand

Main command of Quarkdown CLI, which delegates to subcommands.

Constructors

QuarkdownCommand

constructor()

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

val messages: List<String>

printHelpOnEmptyArgs

open val printHelpOnEmptyArgs: Boolean

treatUnknownOptionsAsArgs

open val treatUnknownOptionsAsArgs: Boolean

Functions

open override fun aliases(): <Error class: unknown class>

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

browserLauncherOption

fun CliktCommand.browserLauncherOption(default: BrowserLauncher = NoneBrowserLauncher(), shouldValidate: () -> Boolean = { true }, envLookup: (String) -> String? = System::getenv): OptionDelegate<out BrowserLauncher?>

Option to select a browser launcher from the CLI, with validation and support of selection by name, path, or fixed choices.

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

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

registerOptionGroup

fun registerOptionGroup(group: ParameterGroup)

fun resetContext(parent: Context?): Context

open override fun run()

open override fun toString(): String