Skip to content

clikt / com.github.ajalt.clikt.parameters.arguments / argument


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

Create a property delegate argument.

The order that these delegates are created is the order that arguments must appear. By default, the argument takes one value and throws an error if no value is given. The behavior can be changed with functions like int and optional.


name - The metavar for this argument. If not given, the name is inferred form the property name.

help - The description of this argument for help output.

helpTags - Extra information about this option to pass to the help formatter