AbstractDoctorGetPathCommand

abstract class AbstractDoctorGetPathCommand(name: String, description: String) : CliktCommand

Base class for doctor get <name> subcommands that print the absolute filesystem path of a single entry in the Quarkdown install layout to standard output.

Subclasses select the entry to print by overriding getFile, and provide a human-readable description used in error messages. The command exits with a non-zero status if the install layout cannot be resolved or if the entry does not exist on disk.

Parameters

name

name of the leaf subcommand (e.g. install-dir)

description

human-readable description of the entry, used in error messages (e.g. "Quarkdown install directory")

Inheritors

Constructors

Link copied to clipboard
constructor(name: String, description: String)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val currentContext: Context
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open fun aliases(): Map<String, List<String>>
Link copied to clipboard
open fun allHelpParams(): List<HelpFormatter.ParameterHelp>
Link copied to clipboard
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.

Link copied to clipboard
open fun commandHelp(context: Context): String
Link copied to clipboard
open fun commandHelpEpilog(context: Context): String
Link copied to clipboard
fun configureContext(block: Context.Builder.() -> Unit)
Link copied to clipboard
fun echo()
fun echo(message: Any?, trailingNewline: Boolean, err: Boolean)
Link copied to clipboard
fun echoFormattedHelp(error: CliktError?)
Link copied to clipboard
fun getFormattedHelp(error: CliktError?): String?
Link copied to clipboard
open fun help(context: Context): String
Link copied to clipboard
open fun helpEpilog(context: Context): String
Link copied to clipboard
fun issueMessage(message: String)
Link copied to clipboard
fun registerArgument(argument: Argument)
Link copied to clipboard
fun registeredArguments(): List<Argument>
Link copied to clipboard
fun registeredOptions(): List<Option>
Link copied to clipboard
fun registeredParameterGroups(): List<ParameterGroup>
Link copied to clipboard
fun registeredSubcommands(): List<CoreCliktCommand>
Link copied to clipboard
open override fun registerOption(option: GroupableOption)
fun registerOption(option: Option)
Link copied to clipboard
fun registerOptionGroup(group: ParameterGroup)
Link copied to clipboard
fun resetContext(parent: Context?): Context
Link copied to clipboard
override fun run()
Link copied to clipboard
open override fun toString(): String