Api

A simple command line argument parser.

Usage:

1. Define parameters with param, requiredParam, repeatedParam and command. Each of these methods gives back a handle to a future argument value.

2. Call parse() with actual arguments.

3. 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)

A typeclass that defines how to convert a string from a single command line argument to a given type.

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.

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.

Find all methods annotated with @argparse.main declared in the container A.

class Container() {

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.

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.