diff --git a/api/clikt-mordant-markdown/navigation.html b/api/clikt-mordant-markdown/navigation.html index 493971a6..6ab3024f 100755 --- a/api/clikt-mordant-markdown/navigation.html +++ b/api/clikt-mordant-markdown/navigation.html @@ -17,12 +17,17 @@ CoreSuspendingCliktCommand -
+
+ +
+
-
+
@@ -32,76 +37,86 @@ -
+ +
-
+
-
+ -
+
-
+ -
+
-
+ -
+ -
+ -
+ - -
+ -
+ -
@@ -1057,7 +1072,12 @@ SuspendingCliktCommand
-
+ +
diff --git a/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-clikt-command/index.html b/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-clikt-command/index.html index c06f361b..72758271 100755 --- a/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-clikt-command/index.html +++ b/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-clikt-command/index.html @@ -62,7 +62,7 @@

SuspendingCliktCommand

-

A version of CliktCommand that supports a suspending run function.

+

A version of CliktCommand that supports a suspending run function.

Inheritors

diff --git a/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-no-op-clikt-command/-suspending-no-op-clikt-command.html b/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-no-op-clikt-command/-suspending-no-op-clikt-command.html new file mode 100755 index 00000000..75afded9 --- /dev/null +++ b/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-no-op-clikt-command/-suspending-no-op-clikt-command.html @@ -0,0 +1,76 @@ + + + + + SuspendingNoOpCliktCommand + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

SuspendingNoOpCliktCommand

+
+
constructor(name: String? = null)
+
+ +
+
+
+ + + diff --git a/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-no-op-clikt-command/index.html b/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-no-op-clikt-command/index.html new file mode 100755 index 00000000..65b0ebb7 --- /dev/null +++ b/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-no-op-clikt-command/index.html @@ -0,0 +1,633 @@ + + + + + SuspendingNoOpCliktCommand + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

SuspendingNoOpCliktCommand

+

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

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(name: String? = null)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+ +
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+ +
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+ +
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+ +
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val BaseCliktCommand<*>.terminal: Terminal

A shortcut for accessing the terminal from the currentContext

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun aliases(): Map<String, List<String>>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun commandHelp(context: Context): String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun commandHelpEpilog(context: Context): String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun echo()
fun echo(message: Any?, trailingNewline: Boolean, err: Boolean)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+ +
+
+
+ + +
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 BaseCliktCommand<*>.installMordant(force: Boolean = false)

Set up this command's context to use Mordant for rendering.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun issueMessage(message: String)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun registerArgument(argument: Argument)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+ +
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun registerOption(option: GroupableOption)
fun registerOption(option: Option)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+ +
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+ +
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open suspend override fun run()
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
suspend fun SuspendingCliktCommand.test(argv: Array<String>, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE): CliktCommandTestResult
suspend fun SuspendingCliktCommand.test(argv: String, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE): CliktCommandTestResult
suspend fun SuspendingCliktCommand.test(argv: List<String>, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE): CliktCommandTestResult
inline fun <T : BaseCliktCommand<T>> BaseCliktCommand<T>.test(argv: List<String>, stdin: String = "", envvars: Map<String, String> = emptyMap(), includeSystemEnvvars: Boolean = false, ansiLevel: AnsiLevel = AnsiLevel.NONE, width: Int = 79, height: Int = 24, hyperlinks: Boolean = ansiLevel != AnsiLevel.NONE, outputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, inputInteractive: Boolean = ansiLevel != AnsiLevel.NONE, parse: (argv: List<String>) -> Unit): CliktCommandTestResult

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + + diff --git a/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-no-op-clikt-command/run.html b/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-no-op-clikt-command/run.html new file mode 100755 index 00000000..18243aaf --- /dev/null +++ b/api/clikt-mordant/com.github.ajalt.clikt.command/-suspending-no-op-clikt-command/run.html @@ -0,0 +1,76 @@ + + + + + run + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

run

+
+
open suspend override fun run()
+
+ +
+
+
+ + + diff --git a/api/clikt-mordant/com.github.ajalt.clikt.command/index.html b/api/clikt-mordant/com.github.ajalt.clikt.command/index.html index 608a62c6..e2a411ec 100755 --- a/api/clikt-mordant/com.github.ajalt.clikt.command/index.html +++ b/api/clikt-mordant/com.github.ajalt.clikt.command/index.html @@ -98,6 +98,21 @@

Types

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
diff --git a/api/clikt-mordant/com.github.ajalt.clikt.core/-no-op-clikt-command/index.html b/api/clikt-mordant/com.github.ajalt.clikt.core/-no-op-clikt-command/index.html index fd87b628..c52993c1 100755 --- a/api/clikt-mordant/com.github.ajalt.clikt.core/-no-op-clikt-command/index.html +++ b/api/clikt-mordant/com.github.ajalt.clikt.core/-no-op-clikt-command/index.html @@ -62,7 +62,7 @@

NoOpCliktCommand

-
open class NoOpCliktCommand(name: String? = null) : CliktCommand

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

+
open class NoOpCliktCommand(name: String? = null) : CliktCommand

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

diff --git a/api/clikt-mordant/com.github.ajalt.clikt.core/index.html b/api/clikt-mordant/com.github.ajalt.clikt.core/index.html index 8eafb14b..9e04fa6b 100755 --- a/api/clikt-mordant/com.github.ajalt.clikt.core/index.html +++ b/api/clikt-mordant/com.github.ajalt.clikt.core/index.html @@ -93,7 +93,7 @@

Types

-
open class NoOpCliktCommand(name: String? = null) : CliktCommand

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

+
open class NoOpCliktCommand(name: String? = null) : CliktCommand

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

diff --git a/api/clikt-mordant/navigation.html b/api/clikt-mordant/navigation.html index 493971a6..6ab3024f 100755 --- a/api/clikt-mordant/navigation.html +++ b/api/clikt-mordant/navigation.html @@ -17,12 +17,17 @@ CoreSuspendingCliktCommand
-
+ + -
+
@@ -32,76 +37,86 @@ -
+ +
-
+
-
+ -
+
-
+ -
+
-
+ -
+ -
+ -
+ - -
+ -
+ -
@@ -1057,7 +1072,12 @@ SuspendingCliktCommand
-
+ +
diff --git a/api/clikt/com.github.ajalt.clikt.command/-core-chained-clikt-command/index.html b/api/clikt/com.github.ajalt.clikt.command/-core-chained-clikt-command/index.html index 5cbde961..04d32d80 100755 --- a/api/clikt/com.github.ajalt.clikt.command/-core-chained-clikt-command/index.html +++ b/api/clikt/com.github.ajalt.clikt.command/-core-chained-clikt-command/index.html @@ -62,7 +62,7 @@

CoreChainedCliktCommand

-

A version of CoreCliktCommand that returns a value from the run function, which is then passed to subcommands.

This command works best if you set allowMultipleSubcommands to true.

+

A version of CoreCliktCommand that returns a value from the run function, which is then passed to subcommands.

This command works best if you set allowMultipleSubcommands to true.

Inheritors

diff --git a/api/clikt/com.github.ajalt.clikt.command/-core-suspending-clikt-command/index.html b/api/clikt/com.github.ajalt.clikt.command/-core-suspending-clikt-command/index.html index 8c9e88d6..a1f407e3 100755 --- a/api/clikt/com.github.ajalt.clikt.command/-core-suspending-clikt-command/index.html +++ b/api/clikt/com.github.ajalt.clikt.command/-core-suspending-clikt-command/index.html @@ -62,7 +62,7 @@

CoreSuspendingCliktCommand

-

A version of CoreCliktCommand that supports a suspending run function.

+
diff --git a/api/clikt/com.github.ajalt.clikt.command/-core-suspending-no-op-clikt-command/-core-suspending-no-op-clikt-command.html b/api/clikt/com.github.ajalt.clikt.command/-core-suspending-no-op-clikt-command/-core-suspending-no-op-clikt-command.html new file mode 100755 index 00000000..26998d61 --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.command/-core-suspending-no-op-clikt-command/-core-suspending-no-op-clikt-command.html @@ -0,0 +1,76 @@ + + + + + CoreSuspendingNoOpCliktCommand + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

CoreSuspendingNoOpCliktCommand

+
+
constructor(name: String? = null)
+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.command/-core-suspending-no-op-clikt-command/index.html b/api/clikt/com.github.ajalt.clikt.command/-core-suspending-no-op-clikt-command/index.html new file mode 100755 index 00000000..3f5dbc98 --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.command/-core-suspending-no-op-clikt-command/index.html @@ -0,0 +1,708 @@ + + + + + CoreSuspendingNoOpCliktCommand + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

CoreSuspendingNoOpCliktCommand

+

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

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(name: String? = null)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

If true, allow multiple of this command's subcommands to be called sequentially. This will disable allowInterspersedArgs on the context of this command and its descendants.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

The envvar to use to enable shell autocomplete script generation. Set to null to disable generation.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

The name of this command, used in help output.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

This command's context.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

If true, don't display this command in help output when used as a subcommand.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

All messages issued during parsing.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

If true, any options on the command line whose names aren't valid will be parsed as an argument rather than reporting an error. You'll need to define an argument().multiple() to collect these options, or an error will still be reported. Unknown short option flags grouped with other flags on the command line will always be reported as errors.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun aliases(): Map<String, List<String>>

A list of command aliases.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun BaseCliktCommand<*>.argument(name: String = "", help: String = "", helpTags: Map<String, String> = emptyMap(), completionCandidates: CompletionCandidates? = null): RawArgument

Create a property delegate argument.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun commandHelp(context: Context): String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun commandHelpEpilog(context: Context): String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Configure this command's Context.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun echo()

Print a line break to stdout

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

Print the message to the screen.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun echoFormattedHelp(error: CliktError? = null)

Echo the string returned by getFormattedHelp.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
inline fun <T : Any> BaseCliktCommand<*>.findObject(key: String = Context.DEFAULT_OBJ_KEY): ReadOnlyProperty<BaseCliktCommand<*>, T?>

Find the closest object of type T, or null

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
inline fun <T : Any> BaseCliktCommand<*>.findOrSetObject(key: String = Context.DEFAULT_OBJ_KEY, crossinline default: () -> T): ReadOnlyProperty<BaseCliktCommand<*>, T>

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun getFormattedHelp(error: CliktError? = null): String?

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun help(context: Context): String

The help text for this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun helpEpilog(context: Context): String

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun issueMessage(message: String)

Add a message to be printed after parsing

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun registerArgument(argument: Argument)

Register an argument with this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

The names of all direct children of this command

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun registerOption(option: GroupableOption)

Register an option with this command or group.

fun registerOption(option: Option)

Register an option with this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Register a group with this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
inline fun <T : Any> BaseCliktCommand<*>.requireObject(key: String = Context.DEFAULT_OBJ_KEY): ReadOnlyProperty<BaseCliktCommand<*>, T>

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun resetContext(parent: Context? = null): Context

Create a new context for this command and all its subcommands recursively.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open suspend override fun run()

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.command/-core-suspending-no-op-clikt-command/run.html b/api/clikt/com.github.ajalt.clikt.command/-core-suspending-no-op-clikt-command/run.html new file mode 100755 index 00000000..0c79386a --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.command/-core-suspending-no-op-clikt-command/run.html @@ -0,0 +1,76 @@ + + + + + run + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

run

+
+
open suspend override fun run()

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

This is called after command line parsing is complete. If this command is a subcommand, this will only be called if the subcommand is invoked.

If one of this command's subcommands is invoked, this is called before the subcommand's arguments are parsed.

+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.command/index.html b/api/clikt/com.github.ajalt.clikt.command/index.html index f87c1f6e..c38f0e50 100755 --- a/api/clikt/com.github.ajalt.clikt.command/index.html +++ b/api/clikt/com.github.ajalt.clikt.command/index.html @@ -98,6 +98,21 @@

Types

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
diff --git a/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/-chained-completion-command.html b/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/-chained-completion-command.html new file mode 100755 index 00000000..e17e2868 --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/-chained-completion-command.html @@ -0,0 +1,76 @@ + + + + + ChainedCompletionCommand + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

ChainedCompletionCommand

+
+
constructor(help: String = "Generate a tab-complete script for the given shell", epilog: String = "", name: String = "generate-completion")
+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/help-epilog.html b/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/help-epilog.html new file mode 100755 index 00000000..26ed9c57 --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/help-epilog.html @@ -0,0 +1,76 @@ + + + + + helpEpilog + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

helpEpilog

+
+
open override fun helpEpilog(context: Context): String

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

+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/help.html b/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/help.html new file mode 100755 index 00000000..49281b12 --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/help.html @@ -0,0 +1,76 @@ + + + + + help + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

help

+
+
open override fun help(context: Context): String

The help text for this command.

Example:

class Command: CliktCommand() {
override fun commandHelp(context: Context): String {
return context.theme.info("This is a command")
}
}
+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/index.html b/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/index.html new file mode 100755 index 00000000..f179802f --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/index.html @@ -0,0 +1,708 @@ + + + + + ChainedCompletionCommand + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

ChainedCompletionCommand

+
class ChainedCompletionCommand<T>(help: String = "Generate a tab-complete script for the given shell", epilog: String = "", name: String = "generate-completion") : CoreChainedCliktCommand<T>

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

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(help: String = "Generate a tab-complete script for the given shell", epilog: String = "", name: String = "generate-completion")
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

If true, allow multiple of this command's subcommands to be called sequentially. This will disable allowInterspersedArgs on the context of this command and its descendants.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

The envvar to use to enable shell autocomplete script generation. Set to null to disable generation.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

The name of this command, used in help output.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

This command's context.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

If true, don't display this command in help output when used as a subcommand.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

All messages issued during parsing.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

If true, any options on the command line whose names aren't valid will be parsed as an argument rather than reporting an error. You'll need to define an argument().multiple() to collect these options, or an error will still be reported. Unknown short option flags grouped with other flags on the command line will always be reported as errors.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun aliases(): Map<String, List<String>>

A list of command aliases.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun BaseCliktCommand<*>.argument(name: String = "", help: String = "", helpTags: Map<String, String> = emptyMap(), completionCandidates: CompletionCandidates? = null): RawArgument

Create a property delegate argument.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun commandHelp(context: Context): String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun commandHelpEpilog(context: Context): String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Configure this command's Context.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun echo()

Print a line break to stdout

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

Print the message to the screen.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun echoFormattedHelp(error: CliktError? = null)

Echo the string returned by getFormattedHelp.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
inline fun <T : Any> BaseCliktCommand<*>.findObject(key: String = Context.DEFAULT_OBJ_KEY): ReadOnlyProperty<BaseCliktCommand<*>, T?>

Find the closest object of type T, or null

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
inline fun <T : Any> BaseCliktCommand<*>.findOrSetObject(key: String = Context.DEFAULT_OBJ_KEY, crossinline default: () -> T): ReadOnlyProperty<BaseCliktCommand<*>, T>

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun getFormattedHelp(error: CliktError? = null): String?

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun help(context: Context): String

The help text for this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun helpEpilog(context: Context): String

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun issueMessage(message: String)

Add a message to be printed after parsing

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun <T> CoreChainedCliktCommand<T>.main(argv: Array<out String>, initial: T): T
fun <T> CoreChainedCliktCommand<T>.main(argv: List<String>, initial: T): T

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun <T> CoreChainedCliktCommand<T>.parse(argv: Array<String>, initial: T): T
fun <T> CoreChainedCliktCommand<T>.parse(argv: List<String>, initial: T): T

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun registerArgument(argument: Argument)

Register an argument with this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

The names of all direct children of this command

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun registerOption(option: GroupableOption)

Register an option with this command or group.

fun registerOption(option: Option)

Register an option with this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Register a group with this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
inline fun <T : Any> BaseCliktCommand<*>.requireObject(key: String = Context.DEFAULT_OBJ_KEY): ReadOnlyProperty<BaseCliktCommand<*>, T>

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun resetContext(parent: Context? = null): Context

Create a new context for this command and all its subcommands recursively.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun run(value: T): T

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/run.html b/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/run.html new file mode 100755 index 00000000..25843dcc --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.completion/-chained-completion-command/run.html @@ -0,0 +1,76 @@ + + + + + run + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

run

+
+
open override fun run(value: T): T

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

This takes the value returned by the previously invoked command and returns a new value.

This is called after command line parsing is complete. If this command is a subcommand, this will only be called if the subcommand is invoked.

If one of this command's subcommands is invoked, this is called before the subcommand's arguments are parsed.

+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/-suspending-completion-command.html b/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/-suspending-completion-command.html new file mode 100755 index 00000000..b0f65c11 --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/-suspending-completion-command.html @@ -0,0 +1,76 @@ + + + + + SuspendingCompletionCommand + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

SuspendingCompletionCommand

+
+
constructor(help: String = "Generate a tab-complete script for the given shell", epilog: String = "", name: String = "generate-completion")
+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/help-epilog.html b/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/help-epilog.html new file mode 100755 index 00000000..8c78394a --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/help-epilog.html @@ -0,0 +1,76 @@ + + + + + helpEpilog + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

helpEpilog

+
+
open override fun helpEpilog(context: Context): String

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

+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/help.html b/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/help.html new file mode 100755 index 00000000..50a17b78 --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/help.html @@ -0,0 +1,76 @@ + + + + + help + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

help

+
+
open override fun help(context: Context): String

The help text for this command.

Example:

class Command: CliktCommand() {
override fun commandHelp(context: Context): String {
return context.theme.info("This is a command")
}
}
+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/index.html b/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/index.html new file mode 100755 index 00000000..1492d1b6 --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/index.html @@ -0,0 +1,708 @@ + + + + + SuspendingCompletionCommand + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

SuspendingCompletionCommand

+
class SuspendingCompletionCommand(help: String = "Generate a tab-complete script for the given shell", epilog: String = "", name: String = "generate-completion") : CoreSuspendingCliktCommand

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

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(help: String = "Generate a tab-complete script for the given shell", epilog: String = "", name: String = "generate-completion")
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+

If true, allow multiple of this command's subcommands to be called sequentially. This will disable allowInterspersedArgs on the context of this command and its descendants.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

The envvar to use to enable shell autocomplete script generation. Set to null to disable generation.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

The name of this command, used in help output.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

This command's context.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

If true, don't display this command in help output when used as a subcommand.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

All messages issued during parsing.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

If true, any options on the command line whose names aren't valid will be parsed as an argument rather than reporting an error. You'll need to define an argument().multiple() to collect these options, or an error will still be reported. Unknown short option flags grouped with other flags on the command line will always be reported as errors.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun aliases(): Map<String, List<String>>

A list of command aliases.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun BaseCliktCommand<*>.argument(name: String = "", help: String = "", helpTags: Map<String, String> = emptyMap(), completionCandidates: CompletionCandidates? = null): RawArgument

Create a property delegate argument.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun commandHelp(context: Context): String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open fun commandHelpEpilog(context: Context): String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Configure this command's Context.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun echo()

Print a line break to stdout

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

Print the message to the screen.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun echoFormattedHelp(error: CliktError? = null)

Echo the string returned by getFormattedHelp.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
inline fun <T : Any> BaseCliktCommand<*>.findObject(key: String = Context.DEFAULT_OBJ_KEY): ReadOnlyProperty<BaseCliktCommand<*>, T?>

Find the closest object of type T, or null

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
inline fun <T : Any> BaseCliktCommand<*>.findOrSetObject(key: String = Context.DEFAULT_OBJ_KEY, crossinline default: () -> T): ReadOnlyProperty<BaseCliktCommand<*>, T>

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun getFormattedHelp(error: CliktError? = null): String?

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun help(context: Context): String

The help text for this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun helpEpilog(context: Context): String

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun issueMessage(message: String)

Add a message to be printed after parsing

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
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.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun registerArgument(argument: Argument)

Register an argument with this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

The names of all direct children of this command

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun registerOption(option: GroupableOption)

Register an option with this command or group.

fun registerOption(option: Option)

Register an option with this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+

Register a group with this command.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
inline fun <T : Any> BaseCliktCommand<*>.requireObject(key: String = Context.DEFAULT_OBJ_KEY): ReadOnlyProperty<BaseCliktCommand<*>, T>

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun resetContext(parent: Context? = null): Context

Create a new context for this command and all its subcommands recursively.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open suspend override fun run()

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

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+
+
+
+
+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/run.html b/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/run.html new file mode 100755 index 00000000..03591c04 --- /dev/null +++ b/api/clikt/com.github.ajalt.clikt.completion/-suspending-completion-command/run.html @@ -0,0 +1,76 @@ + + + + + run + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ +
+

run

+
+
open suspend override fun run()

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

This is called after command line parsing is complete. If this command is a subcommand, this will only be called if the subcommand is invoked.

If one of this command's subcommands is invoked, this is called before the subcommand's arguments are parsed.

+
+ +
+
+
+ + + diff --git a/api/clikt/com.github.ajalt.clikt.completion/index.html b/api/clikt/com.github.ajalt.clikt.completion/index.html index 681b7849..6fa27e01 100755 --- a/api/clikt/com.github.ajalt.clikt.completion/index.html +++ b/api/clikt/com.github.ajalt.clikt.completion/index.html @@ -68,7 +68,22 @@

Package-level declaratio

Types

-
+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
class ChainedCompletionCommand<T>(help: String = "Generate a tab-complete script for the given shell", epilog: String = "", name: String = "generate-completion") : CoreChainedCliktCommand<T>

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

+
+
+
+
+
@@ -113,6 +128,21 @@

Types

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
class SuspendingCompletionCommand(help: String = "Generate a tab-complete script for the given shell", epilog: String = "", name: String = "generate-completion") : CoreSuspendingCliktCommand

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

+
+
+
+
diff --git a/api/clikt/com.github.ajalt.clikt.core/-no-such-option/-no-such-option.html b/api/clikt/com.github.ajalt.clikt.core/-no-such-option/-no-such-option.html index 08066b8c..8a876019 100755 --- a/api/clikt/com.github.ajalt.clikt.core/-no-such-option/-no-such-option.html +++ b/api/clikt/com.github.ajalt.clikt.core/-no-such-option/-no-such-option.html @@ -58,12 +58,12 @@
-
+

NoSuchOption

-
constructor(paramName: String, possibilities: List<String> = emptyList())
+
constructor(paramName: String, possibilities: List<String> = emptyList(), subcommand: String? = null)