core

Type Members

1. case class Args() extends CommandLineArgSpecA[List[String]] with Product with Serializable

   

2. abstract class ArgumentValueParser[T] extends AnyRef

   

   Type class that provides the functionality to parse a command line argument of type String into a value of type T.

3. abstract class ArgumentValuePrinter[T] extends AnyRef

   

4. case class Command(name: Option[String] = None, header: Option[String] = None, description: Option[String] = None, printOptionDefaultValues: Boolean = true, addDotToDescriptions: Boolean = true, help: Boolean = true, version: Option[String] = None, clusteredShortOptionsAllowed: Boolean = true, prefixLongOptionsWith: Option[String] = Some("--"), prefixShortOptionsWith: Option[String] = Some("-"), headerHeading: Option[String] = None, synopsisHeading: Option[String] = None, descriptionHeading: Option[String] = None, parameterListHeading: Option[String] = None, optionListHeading: Option[String] = None, commandListHeading: Option[String] = None, footerHeading: Option[String] = None, printStackTraceOnException: Boolean = false) extends Product with Serializable

   

5. type CommandLine[A] = Free[CommandLineArgSpecA, IO[A]]

   

6. type CommandLineArgSpec[A] = Free[CommandLineArgSpecA, A]

   

7. trait CommandLineArgSpecA[A] extends AnyRef

   

8. abstract class CommandLineArgSpecAWithValueParser[A, P] extends CommandLineArgSpecA[A]

   

9. case class CommandLineArgSpecInSubcommand[A](commandLine: CommandLine[A]) extends Product with Serializable

   

10. trait CommandLineParserDsl extends AnyRef

    

11. case class CommandLineParsingFailed(cause: Throwable) extends IllegalStateException with Product with Serializable

    

    Used internally to signal command line parsing failure.

12. case class CommandLineParsingFailedForSubcommand(name: String, cause: Throwable) extends IllegalStateException with Product with Serializable

    

    Used internally to signal command line parsing failure for a subcommand.

13. case class CommandWithCommandLine[A](command: Command, commandLine: CommandLine[A]) extends CommandLineArgSpecA[IO[A]] with Product with Serializable

    

14. sealed abstract class HelpRequested extends IllegalStateException

    

15. case class IncorrectCommandLineUsage(message: String) extends IllegalStateException with Product with Serializable

    

    Use this exception to signal an error in the command line usage.

    Use this exception to signal an error in the command line usage. It is handled like any other exception, but it also prints the usage help.

16. case class IncorrectCommandLineUsageInSubcommand(cause: IncorrectCommandLineUsage) extends IllegalStateException with Product with Serializable

    

    Used internally to differentiate between error in subcommand and main command.

17. trait Logging extends AnyRef

    

    Isolate from Scala Logging and make wiring more flexible.

18. abstract class MultiParamSpec[A, T] extends ParamSpec[A, T]

    

19. case class NoSpec[A](result: IO[A]) extends CommandLineArgSpecA[IO[A]] with Product with Serializable

    

20. case class Opt[T](name: String, label: Option[String] = None, description: Option[String] = None, aliases: Seq[String] = Seq())(implicit evidence$7: ArgumentValueParser[T]) extends OptSpec[Option[T], T] with Product with Serializable

    

21. abstract class OptSpec[A, P] extends CommandLineArgSpecAWithValueParser[A, P]

    

22. case class OptWithDefaultValue[T](name: String, defaultValue: T, label: Option[String] = None, description: Option[String] = None, aliases: Seq[String] = Seq())(implicit evidence$8: ArgumentValueParser[T], evidence$9: ArgumentValuePrinter[T]) extends OptSpec[T, T] with Product with Serializable

    

23. case class OptWithRequiredValue[T](name: String, label: Option[String] = None, description: Option[String] = None, aliases: Seq[String] = Seq())(implicit evidence$10: ArgumentValueParser[T]) extends OptSpec[T, T] with Product with Serializable

    

24. case class Param[T](label: Option[String] = None, description: Option[String] = None, index: Option[Int] = None)(implicit evidence$14: ArgumentValueParser[T]) extends SingleParamSpec[Option[T], T] with Product with Serializable

    

25. case class ParamRange[T](label: Option[String] = None, description: Option[String] = None, fromIndex: Int = 0, toIndex: Option[Int] = None)(implicit evidence$18: ArgumentValueParser[T]) extends ParamSpec[List[T], T] with Product with Serializable

    

26. abstract class ParamSpec[A, T] extends CommandLineArgSpecAWithValueParser[A, T]

    

27. case class ParamWithDefaultValue[T](defaultValue: T, label: Option[String] = None, description: Option[String] = None, index: Option[Int] = None)(implicit evidence$15: ArgumentValueParser[T], evidence$16: ArgumentValuePrinter[T]) extends SingleParamSpec[T, T] with Product with Serializable

    

28. case class ParamWithRequiredValue[T](label: Option[String] = None, description: Option[String] = None, index: Option[Int] = None)(implicit evidence$17: ArgumentValueParser[T]) extends SingleParamSpec[T, T] with Product with Serializable

    

29. abstract class SingleParamSpec[A, T] extends ParamSpec[A, T]

    

30. case class Subcommand[A](name: String, header: Option[String] = None, description: Option[String] = None, aliases: Seq[String] = Seq()) extends Product with Serializable

    

31. case class SubcommandWithCommandLine[A](subcommand: Subcommand[A], commandLine: CommandLine[A]) extends CommandLineArgSpecA[IO[A]] with Product with Serializable

    

32. case class UsageHelpRequested() extends HelpRequested with Product with Serializable

    

    Used internally to signal usage help request (triggered by --help usually).

33. case class VersionHelpRequested() extends HelpRequested with Product with Serializable

    

    Used internally to signal version help request (triggered by --version usually).