clikt/com.github.ajalt.clikt.core/NoOpCliktCommand

NoOpCliktCommand

open class NoOpCliktCommand(help: String = "", epilog: String = "", name: String? = null, val invokeWithoutSubcommand: Boolean = false, val printHelpOnEmptyArgs: Boolean = false, val helpTags: Map<String, String> = emptyMap(), autoCompleteEnvvar: String? = "", allowMultipleSubcommands: Boolean = false, hidden: Boolean = false) : CliktCommand

A CliktCommand that has a default implementation of CliktCommand.run that is a no-op.

Constructors

NoOpCliktCommand

constructor(help: String = "", epilog: String = "", name: String? = null, invokeWithoutSubcommand: Boolean = false, printHelpOnEmptyArgs: Boolean = false, helpTags: Map<String, String> = emptyMap(), autoCompleteEnvvar: String? = "", allowMultipleSubcommands: Boolean = false, hidden: Boolean = false)

Properties

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>

Extra information about this option to pass to the help formatter.

invokeWithoutSubcommand

val invokeWithoutSubcommand: Boolean = false

Used when this command has subcommands, and this command is called without a subcommand. If true, run will be called. By default, a PrintHelpMessage is thrown instead.

messages

val messages: List<String>

All messages issued during parsing.

printHelpOnEmptyArgs

val printHelpOnEmptyArgs: Boolean = false

If this command is called with no values on the command line, print a help message (by throwing PrintHelpMessage) if this is true, otherwise run normally.

terminal

val CliktCommand.terminal: Terminal

A short for accessing the terminal from the currentContext

Functions

aliases

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

A list of command aliases.

allHelpParams

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

Return the parameters that should be sent to the help formatter when this command's getFormattedHelp is called.

argument

fun CliktCommand.argument(name: String = "", help: String = "", helpTags: Map<String, String> = emptyMap(), completionCandidates: CompletionCandidates? = null): RawArgument

Create a property delegate argument.

commandHelp

open fun commandHelp(context: Context): String

The help text for this command.

commandHelpEpilog

open fun commandHelpEpilog(context: Context): String

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

echo

fun echo()

Print a line break to stdout

fun echo(message: Any?, trailingNewline: Boolean = true, err: Boolean = false)

Print the message to the screen.

echoFormattedHelp

fun echoFormattedHelp(error: CliktError? = null)

Echo the string returned by getFormattedHelp.

findObject

inline fun <T : Any> CliktCommand.findObject(): ReadOnlyProperty<CliktCommand, T?>

Find the closest object of type T, or null

findOrSetObject

inline fun <T : Any> CliktCommand.findOrSetObject(crossinline default: () -> T): ReadOnlyProperty<CliktCommand, T>

Find the closest object of type T, setting context.obj if one is not found.

getFormattedHelp

fun getFormattedHelp(error: CliktError? = null): String?

Return the help string for this command, optionally with an error.

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.

mutuallyExclusiveOptions

fun <T : Any> ParameterHolder.mutuallyExclusiveOptions(option1: OptionDelegate<out T?>, option2: OptionDelegate<out T?>, vararg options: OptionDelegate<out T?>, name: String? = null, help: String? = null): MutuallyExclusiveOptions<T, T?>

Declare a set of two or more mutually exclusive options.

option

fun ParameterHolder.option(vararg names: String, help: String = "", metavar: String? = null, hidden: Boolean = false, envvar: String? = null, helpTags: Map<String, String> = emptyMap(), completionCandidates: CompletionCandidates? = null, valueSourceKey: String? = null, eager: Boolean = false): RawOption

Create a property delegate option.

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)

requireObject

inline fun <T : Any> CliktCommand.requireObject(): ReadOnlyProperty<CliktCommand, T>

Find the closest object of type T, or throw a NullPointerException

run

open override fun run()

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

test

@JvmName(name = "varargTest")

fun CliktCommand.test(vararg argv: String, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24): CliktCommandTestResult

fun CliktCommand.test(argv: String, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24): CliktCommandTestResult

fun CliktCommand.test(argv: List<String>, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24): CliktCommandTestResult

Test this command, returning a result that captures the output and result status code.

toString

open override fun toString(): String