zio-cli
API
Generated with
zio-cli/zio.cli

zio.cli

package zio.cli

Members list

Packages

package zio.cli.completion
package zio.cli.figlet
package zio.cli.files
package zio.cli.oauth2

Type members

Classlikes

sealed trait Args[+A]

A Args represents arguments that can be passed to a command-line application.

A Args represents arguments that can be passed to a command-line application.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Both[A, B]
object Empty
class Map[A, B]
class Single[A]
class Variadic[A]
Self type
Args[A]
object Args

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Args.type
sealed trait BuiltInOption extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class ShowHelp
class ShowWizard
object BuiltInOption

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait CliApp[-R, +E, +A]

A CliApp[R, E] is a complete description of a command-line application, which requires environment R, and may fail with a value of type E.

A CliApp[R, E] is a complete description of a command-line application, which requires environment R, and may fail with a value of type E.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Self type
CliApp[R, E, A]
object CliApp

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
CliApp.type
final case class CliConfig(caseSensitive: Boolean, autoCorrectLimit: Int, finalCheckBuiltIn: Boolean, showAllNames: Boolean, showTypes: Boolean)

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.

Value parameters

autoCorrectLimit

Threshold for when to show auto correct suggestions.

caseSensitive

Whether or not to be case sensitive.

finalCheckBuiltIn

Whether or not to check for a BuiltIn option even if it is not a valid command.

showAllNames

Whether or not to show all the names of an option in the synopsis of a command.

showTypes

Whether or not to show the type of an option in the synopsis of a command.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CliConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
CliConfig.type
sealed trait CliError[+E] extends Exception

Attributes

Companion
object
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class BuiltIn
class Execution[E]
class IO
class Parsing
object CliError

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
CliError.type
sealed trait Command[+A]

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

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Map[A, B]
class OrElse[A]
class Single[OptionsType, ArgsType]
class Subcommands[A, B]
Self type
Command[A]
object Command

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Command.type
sealed trait CommandDirective[+A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class BuiltIn
class UserDefined[A]
Self type
object CommandDirective

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Exists

Describes whether the command-line application wants a file/directory to exist or not exist.

Describes whether the command-line application wants a file/directory to exist or not exist.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Either
object No
object Yes
object Exists

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Exists.type
sealed trait HelpDoc

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.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Empty
class Enumeration
class Header
class Paragraph
class Sequence
Show all
Self type
object HelpDoc

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
HelpDoc.type
sealed trait Options[+A]

A Flag[A] models a command-line flag that produces a value of type A.

A Flag[A] models a command-line flag that produces a value of type A.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Both[A, B]
object Empty
class KeyValueMap
class Map[A, B]
class OrElse[A, B]
class Single[A]
class WithDefault[A]
Show all
Self type
Options[A]
object Options

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Options.type
sealed trait PathType

Describes whether the command-line application wants a path to be a file or a directory.

Describes whether the command-line application wants a path to be a file or a directory.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Directory
object Either
object File
object PathType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
PathType.type
sealed trait PrimType[+A]

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.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Bool
object Decimal
object Duration
class Enumeration[A]
object Instant
object Integer
object LocalDate
object LocalDateTime
object LocalTime
object MonthDay
object OffsetTime
class Path
object Period
object Text
object Year
object YearMonth
object ZoneId
object ZoneOffset
object ZonedDateTime
Show all
Self type
object PrimType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
PrimType.type
trait Reducable[-A, -B]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Reducable extends ReducableLowPriority1

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Reducable.type
trait ReducableLowPriority1 extends ReducableLowPriority2

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Reducable
trait ReducableLowPriority2

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Reducable
sealed trait ShellType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Bash
object ZShell
object ShellType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ShellType.type
trait SingleModifier

Attributes

Supertypes
class Object
trait Matchable
class Any
sealed trait UsageSynopsis

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Alternation
object Mixed
class Named
object None
class Optional
class Repeated
class Sequence
Show all
Self type
object UsageSynopsis

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class ValidationError(validationErrorType: ValidationErrorType, error: HelpDoc) extends Throwable

Attributes

Supertypes
trait Product
trait Equals
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
sealed trait ValidationErrorType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object CorrectedFlag
object InvalidValue
object MissingFlag
object MissingValue
Show all
object ValidationErrorType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class Wizard(command: Command[_], conf: CliConfig, header: HelpDoc)

Wizard controls the representation of the Wizard Mode triggered by "--wizard" command.

Wizard controls the representation of the Wizard Mode triggered by "--wizard" command.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Wizard

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Wizard.type
trait ZIOCli extends ZIOApp

Attributes

Supertypes
trait ZIOApp
class Object
trait Matchable
class Any
Known subtypes
trait ZIOCliDefault extends ZIOCli, ZIOAppDefault

Attributes

Supertypes
trait ZIOCli
trait ZIOApp
class Object
trait Matchable
class Any
Show all
Generated with