ParsersApi
Type members
Classlikes
A simple command line argument parser.
A simple command line argument parser.
Usage:
-
Define parameters with param, requiredParam and repeatedParam. Each of these methods gives back a handle to a future argument value.
-
Call
parseOrExit()with actual arguments. -
If parsing succeeds, the arguments will be available in the handles defined in step 1.
If parsing fails, error descriptions are printed and the program exits with 2.
Example:
val parser = argparse.default.ArgumentParser()
val p1 = parser.param[String]("--this-is-a-named-param", default = "default value")
val p2 = parser.param[Int]("positional-param", default = 2)
parser.parseOrExit(Seq("--this-is-a-named-param=other", 5))
println(p1.value)
println(p2.value)
- Value Params
- bashCompletionFlag
Use these flags to print a sourceable bash-completion script. Set to empty to disable.
- description
A short description of this command. Used in help messages.
- helpFlags
Use these flags to print the help message. Set to empty to disable.
- Companion
- object
Inherited classlikes
A typeclass that defines how to convert a string from a single command line argument to a given type.
A typeclass that defines how to convert a string from a single command line argument to a given type.
- Inherited from
- TypesApi
Value members
Concrete methods
The name of the flag to use for generating standalone bash-completion.
The name of the flag to use for generating standalone bash-completion.
Set this to empty to disable bash-completion entirely.
Note that individual argument parsers may override this.
The name of the flag to use for printing help messages.
The name of the flag to use for printing help messages.
Set this to empty to disable help entirely.
Note that individual argument parsers may override this.
Generate a help message from parameters.
Generate a help message from parameters.
This message will be used by ArgumentParsers. Overriding this allows you
to customize the help message of all ArgumentParsers.