quarkdown-cli/com.quarkdown.cli.doctor/DoctorCommand

DoctorCommand

class DoctorCommand : CliktCommand

Top-level command for Quarkdown installation diagnostics and introspection.

Hosts a hierarchy of subcommands that report information about the running Quarkdown distribution. Currently exposes DoctorGetCommand for retrieving individual values (e.g. paths) suitable for shell substitution, with room for diagnostic subcommands (e.g. check) to be added later.

Constructors

DoctorCommand

constructor()

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>

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.

commandHelp