ParsersApi
Type members
Classlikes
A simple command line argument parser.
A simple command line argument parser.
Usage:
-
Define parameters with param, requiredParam, repeatedParam and command. Each of these methods gives back a handle to a future argument value.
-
Call
parse()
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.ArgumentParser("0.1.0")
val p1 = parser.param[String]("--this-is-a-named-param", default = "default value")
val p2 = parser.param[Int]("positional-param", default = 2)
parser.parse(Seq("--this-is-a-named-param=other", 5))
println(p1.value)
println(p2.value)
- Value Params
- description
A short description of this command. Used in help messages.
- enableBashCompletionFlag
Include a
--bash-completion
flag which generate a bash completion script.- enableHelpFlag
Include a
--help
flag which will print a generated help message.- env
The environment.
- stdout
The standard error stream.
- 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 the empty string to disable bash-completion entirely.
Check the style of parameters.
Check the style of parameters.
This is intended to nudge developers into building command line applications that integrate seamlessly into other system utilities and provide a pleasant user experience.
This is subjective, and you may disable style-checking by overriding this method.
Inherited methods
Find all methods annotated with @argparse.main
declared in the container
A
.
Find all methods annotated with @argparse.main
declared in the container
A
.
class Container() {
- Inherited from
- MainArgsApi
Generate a main method for a single entry point.
Generate a main method for a single entry point.
Once annotation macros become available in scala 3, and when container
is static, this method should become obsolete.
- Inherited from
- MainArgsApi