Package-level declarations

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.

Link copied to clipboard

Configurations for generating shell autocomplete suggestions

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

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

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

Functions

Link copied to clipboard
fun <T : BaseCliktCommand<*>> T.completionOption(vararg names: String = arrayOf("--generate-completion"), help: String = "", hidden: Boolean = false): T

Add an option to a command that will print a completion script for the given shell when invoked.