OptParse

Simple Command Line Parsing for Scala

OptParse provides simple command line parsing for Scala that only requires a minimal amount of code.

Hello World Example

import com.frugalmechanic.optparse._

object SimpleApp extends OptParse {
  val name = StrOpt()

  def main(args: Array[String]) {
    parse(args)
    println("Hello "+name.getOrElse("world"))
  }
}

And then you can pass options with:

./simpleApp --name World

./simpleApp -n World

More Complete Example

import com.frugalmechanic.optparse._

object MyApp extends OptParse {
  // --flag (-f is ambiguous since it overlaps with file)
  val flag = BoolOpt()

  // --name (-n is ambiguous since it overlaps with number)
  val name = StrOpt()

  // Can be called multiple times with --aliases or -a (e.g.: --aliases Foo --aliases Bar OR -a Foo -a Bar)
  val aliases = MultiStrOpt()

  // --number (-n is ambiguous since it overlaps with name)
  val number = IntOpt()

  // --file (-f is ambiguous since it overlaps with flag)
  val file = FileOpt()

  def main(args: Array[String]) {
    // Parse the command line arguments
    parse(args)

    // Implicit conversion to bool
    if (flag) println("flag was set!")

    // Implicit conversion to bool to check if a value is set
    if (name) println("Name: "+name.get)

    if (aliases) println("Your alias(es) are: "+aliases.getOrElse(Nil))

    if (number) println("Your number is: "+number.get)

    if (file) println("Your file is: "+file.get)
  }

}

Show help message

./myApp --help

./myApp -h

Pass in some options

./myApp --flag --name Tim --aliases Timothy --aliases Timmy --number 123

Nested Options Object Example

You can also use a nested options object (or class) for parsing the options:

import com.frugalmechanic.optparse._

object MyApp2 {
  object options extends OptParse {
     val flag = BoolOpt()
  }

  def main(args: Array[String]) {
    options.parse(args)

    if (options.flag) println("flag is set")
  }
}

Command Line Option Types

Linear Supertypes

OptParseTypes, OptParseImplicits, AnyRef, Any

Type Members

type ArgOpt[T] = optparse.ArgOpt[T]

Definition Classes
OptParseTypes
type BoolOpt = optparse.BoolOpt

Definition Classes
OptParseTypes
type FileOpt = optparse.FileOpt

Definition Classes
OptParseTypes
type IntOpt = optparse.IntOpt

Definition Classes
OptParseTypes
type MultiOpt[T] = optparse.MultiOpt[T]

Definition Classes
OptParseTypes
type MultiStrOpt = optparse.MultiStrOpt

Definition Classes
OptParseTypes
type Opt = optparse.Opt

Definition Classes
OptParseTypes
type OptParse = optparse.OptParse

Definition Classes
OptParseTypes
type OptVal[T] = optparse.OptVal[T]

Definition Classes
OptParseTypes
type SingleOpt[T] = optparse.SingleOpt[T]

Definition Classes
OptParseTypes
type StrOpt = optparse.StrOpt

Definition Classes
OptParseTypes

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val BoolOpt: optparse.BoolOpt.type

Definition Classes
OptParseTypes
implicit def BoolOptToBool(opt: optparse.BoolOpt): Boolean

Allows "if (MyFlag) ..."
Allows "if (MyFlag) ..."

Definition Classes
OptParseImplicits
val FileOpt: optparse.FileOpt.type

Definition Classes
OptParseTypes
val IntOpt: optparse.IntOpt.type

Definition Classes
OptParseTypes
val MultiStrOpt: optparse.MultiStrOpt.type

Definition Classes
OptParseTypes
implicit def OptToBool[T](opt: optparse.OptVal[T]): Boolean

Allows: if (NameOpt) ...
Allows: if (NameOpt) ... instead of if (NameOpt.value.isDefined) ...

Definition Classes
OptParseImplicits
implicit def OptToSeq[T](opt: optparse.Opt): Seq[optparse.Opt]

Allows BoolOpt(enables=MyOpt) instead of BoolOpt(enables=Seq(MyOpt))
Allows BoolOpt(enables=MyOpt) instead of BoolOpt(enables=Seq(MyOpt))

Definition Classes
OptParseImplicits
implicit def OptValToOption[T](opt: optparse.OptVal[T]): Option[T]

Allows any Option methods to be used on an OptVal
Allows any Option methods to be used on an OptVal

Definition Classes
OptParseImplicits
val StrOpt: optparse.StrOpt.type

Definition Classes
OptParseTypes
implicit def StringToValidateRegex(regex: Regex): (String) ⇒ Boolean

Allows regex usage for the validate option: validate="^[a-zA-Z]+$"
Allows regex usage for the validate option: validate="^[a-zA-Z]+$"

Definition Classes
OptParseImplicits
implicit def ValToOption[T](value: T): Option[T]

Allows longName="name" without needing long=Some("name")
Allows longName="name" without needing long=Some("name")

Definition Classes
OptParseImplicits
val allOpts: ListBuffer[Opt]

Attributes
protected
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def defaultOpt[T](arg: ArgOpt[T]): ArgOpt[T]

Declare a "default option"
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def error(msg: String): Unit

Exit the application with a message
Exit the application with a message

Attributes
protected
def exit(msg: String = null, status: Int = 1): Nothing

Attributes
protected
val foundOpts: ListBuffer[Opt]

Attributes
protected
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def help(): Unit

Print the help message to STDERR
val helpOpt: optparse.BoolOpt

A default help option (--help or -h) that displays the help message
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val longNames: HashMap[String, Opt]

Attributes
protected
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def optName(opt: Opt): String

Attributes
protected
val optParseDebug: Boolean

Override to true to enable simple println's showing what OptParse is doing
val optParseExitOnError: Boolean

By default OptParse will do a System.exit on any parsing errors or when --help is invoked.
By default OptParse will do a System.exit on any parsing errors or when --help is invoked. You can override this to false if you want an IllegalArgumentException exception thrown instead
def parse(args: Array[String]): Unit

Parse the given command line options
val shortNames: HashMap[Char, Opt]

Attributes
protected
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package optparse

trait OptParse extends OptParseImplicits with OptParseTypes

Simple Command Line Parsing for Scala

Hello World Example

More Complete Example

Show help message

Pass in some options

Nested Options Object Example

Command Line Option Types

Type Members

type ArgOpt[T] = optparse.ArgOpt[T]

type BoolOpt = optparse.BoolOpt

type FileOpt = optparse.FileOpt

type IntOpt = optparse.IntOpt

type MultiOpt[T] = optparse.MultiOpt[T]

type MultiStrOpt = optparse.MultiStrOpt

type Opt = optparse.Opt

type OptParse = optparse.OptParse

type OptVal[T] = optparse.OptVal[T]

type SingleOpt[T] = optparse.SingleOpt[T]

type StrOpt = optparse.StrOpt

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val BoolOpt: optparse.BoolOpt.type

implicit def BoolOptToBool(opt: optparse.BoolOpt): Boolean

val FileOpt: optparse.FileOpt.type

val IntOpt: optparse.IntOpt.type

val MultiStrOpt: optparse.MultiStrOpt.type

implicit def OptToBool[T](opt: optparse.OptVal[T]): Boolean

implicit def OptToSeq[T](opt: optparse.Opt): Seq[optparse.Opt]

implicit def OptValToOption[T](opt: optparse.OptVal[T]): Option[T]

val StrOpt: optparse.StrOpt.type

implicit def StringToValidateRegex(regex: Regex): (String) ⇒ Boolean

implicit def ValToOption[T](value: T): Option[T]

val allOpts: ListBuffer[Opt]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def defaultOpt[T](arg: ArgOpt[T]): ArgOpt[T]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def error(msg: String): Unit

def exit(msg: String = null, status: Int = 1): Nothing

val foundOpts: ListBuffer[Opt]

final def getClass(): Class[_]

def hashCode(): Int

def help(): Unit

val helpOpt: optparse.BoolOpt

final def isInstanceOf[T0]: Boolean

val longNames: HashMap[String, Opt]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def optName(opt: Opt): String

val optParseDebug: Boolean

val optParseExitOnError: Boolean

def parse(args: Array[String]): Unit

val shortNames: HashMap[Char, Opt]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from OptParseTypes

Inherited from OptParseImplicits

Inherited from AnyRef

Inherited from Any

Ungrouped