argparse
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. (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())
- Value Params
- description
a short description of this command. Used in help messages.
- prog
the name of this command (only used in the default help message)
- version
the verion of this app. Used in
--version
request.
- Companion
- object
Low-level parsing functionality. See ArgParser for a user-friendly API.
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.
A typeclass that defines how to convert a string from a single command line argument to a given type.
- Companion
- object
Common directories for user applications, as specified by the XDG Base Directory Specification, with some adaptations made for macOS.
Common directories for user applications, as specified by the XDG Base Directory Specification, with some adaptations made for macOS.
- See also
dirs for conventional directories for an application of a given name, including system services.
Deprecated classlikes
Common directories for an application of a given name.
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
- Value Params
- name
the name of the application
- system
use system-wide paths instead of user-specific ones
- Companion
- object
- Deprecated