Command

A Command represents a command in a command-line application. Every command-line application will have at least one command: the application itself. Other command-line applications may support multiple commands.

Self Type: Command[A]

Linear Supertypes

AnyRef, Any

Known Subclasses

Map, OrElse, Single, Subcommands

Abstract Value Members

abstract def helpDoc: HelpDoc
abstract def names: Set[String]
abstract def parse(args: List[String], conf: CliConfig): IO[ValidationError, CommandDirective[A]]
abstract def synopsis: UsageSynopsis

Concrete 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
final def as[B](b: ⇒ B): Command[B]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def map[B](f: (A) ⇒ B): Command[B]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def orElse[A1 >: A](that: Command[A1]): Command[A1]
final def orElseEither[B](that: Command[B]): Command[Either[A, B]]
final def subcommands[B](c1: Command[B], c2: Command[B], cs: Command[B]*)(implicit ev: Reducable[A, B]): Command[Out]
final def subcommands[B](that: Command[B])(implicit ev: Reducable[A, B]): Command[Out]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withHelp(help: HelpDoc): Command[A]
def withHelp(help: String): Command[A]
final def |[A1 >: A](that: Command[A1]): Command[A1]

Related Docs: object Command | package cli

sealed trait Command[+A] extends AnyRef

Abstract Value Members

abstract def helpDoc: HelpDoc

abstract def names: Set[String]

abstract def parse(args: List[String], conf: CliConfig): IO[ValidationError, CommandDirective[A]]

abstract def synopsis: UsageSynopsis

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def as[B](b: ⇒ B): Command[B]

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def map[B](f: (A) ⇒ B): Command[B]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def orElse[A1 >: A](that: Command[A1]): Command[A1]

final def orElseEither[B](that: Command[B]): Command[Either[A, B]]

final def subcommands[B](c1: Command[B], c2: Command[B], cs: Command[B]*)(implicit ev: Reducable[A, B]): Command[Out]

final def subcommands[B](that: Command[B])(implicit ev: Reducable[A, B]): Command[Out]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withHelp(help: HelpDoc): Command[A]

def withHelp(help: String): Command[A]

final def |[A1 >: A](that: Command[A1]): Command[A1]

Inherited from AnyRef

Inherited from Any

Ungrouped