argparse

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. (This behaviour may be changed by subclassing and redefining the check() method).

Example

val parser = argparse.ArgumentParser("appname", "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())

println(p2())

Low-level parsing functionality. See ArgParser for a user-friendly API.

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

Properties of the current terminal.

Common directories for user applications, as specified by the XDG Base Directory Specification, with some adaptations made for macOS.

Common directories for an application of a given name.

The directories here are implemented as a mix of the XDG Base Directory Specification, macOS adaptations and a fallback to classic unix directories for system applications.

Applications are encouraged to use these directories instead of creating their own hierarchies. They are particularly well-suited for use as parameter defaults, for example:

val parser = argparse.ArgParser()
val cache = parser.param[os.Path](
 "--cache-dir",
 default = argparse.dirs("myapp").cache

An argument accessor is a function that returns an argument, assuming that parsing was successful.

Get the system arguments eagerly, this allows using them in a constructor, outside of main().

This may be somewhat of a hack.