package cli
- Alphabetic
- Public
- All
Type Members
-
sealed
trait
Args[+A] extends AnyRef
A
Args
represents arguments that can be passed to a command-line application. - sealed trait BuiltInOption extends Product with Serializable
-
sealed
trait
CliApp[-R, +E, +Model] extends AnyRef
A
CliApp[R, E]
is a complete description of a command-line application, which requires environmentR
, and may fail with a value of typeE
. -
final
case class
CliConfig(caseSensitive: Boolean, autoCorrectLimit: Int) extends Product with Serializable
A
CliConfig
describes how arguments from the command-line are to be parsed by ZIO CLI.A
CliConfig
describes how arguments from the command-line are to be parsed by ZIO CLI.- caseSensitive
Whether or not to be case sensitive.
- autoCorrectLimit
Threshold for when to show auto correct suggestions
-
sealed
trait
Command[+A] extends AnyRef
A
Command
represents a command in a command-line application.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. - sealed trait CommandDirective[+A] extends AnyRef
-
sealed
trait
Exists extends AnyRef
Describes whether the command-line application wants a file/directory to exist or not exist.
-
sealed
trait
HelpDoc extends AnyRef
A
HelpDoc
models the full documentation for a command-line application.A
HelpDoc
models the full documentation for a command-line application.HelpDoc
is composed of optional header and footers, and in-between, a list of HelpDoc-level content items.HelpDoc-level content items, in turn, can be headers, paragraphs, description lists, and enumerations.
A
HelpDoc
can be converted into plaintext, JSON, and HTML. -
sealed
trait
Options[+A] extends AnyRef
A
Flag[A]
models a command-line flag that produces a value of typeA
. -
sealed
trait
PathType extends AnyRef
Describes whether the command-line application wants a path to be a file or a directory.
-
sealed
trait
PrimType[+A] extends AnyRef
A
PrimType
represents the primitive types supported by ZIO CLI.A
PrimType
represents the primitive types supported by ZIO CLI.Each primitive type has a way to parse and validate from a string.
- trait Reducable[-A, -B] extends AnyRef
- trait ReducableLowPriority1 extends ReducableLowPriority2
- trait ReducableLowPriority2 extends AnyRef
- sealed trait ShellType extends AnyRef
- trait SingleModifier extends AnyRef
- sealed trait UsageSynopsis extends AnyRef
- final case class ValidationError(validationErrorType: ValidationErrorType, error: HelpDoc) extends Product with Serializable
- sealed trait ValidationErrorType extends AnyRef
- trait ZIOCli extends ZIOApp
- trait ZIOCliDefault extends ZIOCli with ZIOAppDefault
Value Members
- object Args
- object BuiltInOption extends Serializable
- object CliApp
- object CliConfig extends Serializable
- object Command
- object CommandDirective
- object Exists
- object HelpDoc
- object Options
- object PathType
- object PrimType
- object Reducable extends ReducableLowPriority1
- object ShellType
- object UsageSynopsis
- object ValidationErrorType