clikt/com.github.ajalt.clikt.completion/CompletionCommand

CompletionCommand

class CompletionCommand(help: String, epilog: String, name: String) : CliktCommand

A subcommand that will print a completion script for the given shell when invoked.

Constructors

fun CompletionCommand(help: String = "Generate a tab-complete script for the given shell", epilog: String = "", name: String = "generate-completion")

Functions

aliases

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

A list of command aliases.

getFormattedHelp

open fun getFormattedHelp(): String

Return the full help string for this command.

getFormattedUsage

open fun getFormattedUsage(): String

Return the usage string for this command.

issueMessage

fun issueMessage(message: String)

Add a message to be printed after parsing

main

fun main(argv: Array<out String>)

fun main(argv: List<String>)

Parse the command line and print helpful output if any errors occur.

parse

fun parse(argv: Array<String>, parentContext: Context? = null)

fun parse(argv: List<String>, parentContext: Context? = null)

Parse the command line and throw an exception if parsing fails.

registerArgument

fun registerArgument(argument: Argument)

registeredArguments

fun registeredArguments(): List<Argument>

Get a read-only list of arguments registered in this command (e.g. via registerArgument or an argument delegate)

registeredOptions

fun registeredOptions(): List<Option>

Get a read-only list of options registered in this command (e.g. via registerOption or an option delegate)

registeredParameterGroups

fun registeredParameterGroups(): List<ParameterGroup>

Get a read-only list of groups registered in this command (e.g. via registerOptionGroup or an OptionGroup delegate)

registeredSubcommandNames

fun registeredSubcommandNames(): List<String>

The names of all direct children of this command

registeredSubcommands

fun registeredSubcommands(): List<CliktCommand>

Get a read-only list of commands registered as subcommands of this command.

registerOption

open override fun registerOption(option: GroupableOption)

fun registerOption(option: Option)

registerOptionGroup

fun registerOptionGroup(group: ParameterGroup)

run

open override fun run()

Perform actions after parsing is complete and this command is invoked.

toString

open override fun toString(): String

Properties

commandHelp

open val commandHelp: String

The help text for this command.

commandHelpEpilog

open val commandHelpEpilog: String

Help text to display at the end of the help output, after any parameters.

commandName

val commandName: String

The name of this command, used in help output.

currentContext

val currentContext: Context

This command's context.

helpTags

val helpTags: Map<String, String>

invokeWithoutSubcommand

val invokeWithoutSubcommand: Boolean = false

messages

val messages: List<String>

All messages issued during parsing.

printHelpOnEmptyArgs

val printHelpOnEmptyArgs: Boolean = false