cmdr
package cmdr
- Alphabetic
- By Inheritance
- cmdr
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- class ArgParser extends SettingsParser
A simple command line argument parser.
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 = cmdr.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())
- trait Reader[A] extends AnyRef
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.
- Annotations
- @implicitNotFound("Don't know how to read a ${A} from a command line argument. Try implementing your own cmdr.Reader[$A].")
- trait SettingsParser extends AnyRef
Deprecated Type Members
Value Members
- val ArgumentParser: ArgParser.type
- val argsv: Array[String]
Get the system arguments eagerly, this allows using them in a constructor, outside of main().
Get the system arguments eagerly, this allows using them in a constructor, outside of main().
This may be somewhat of a hack.
- object ArgParser
- object BashCompletion
- object Parser
Low-level parsing functionality.
Low-level parsing functionality. See ArgParser for a user-friendly API.
- object Reader