Wizard

zio.cli.Wizard
See theWizard companion object
final case class Wizard(command: Command[_], conf: CliConfig, header: HelpDoc)

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

Attributes

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

Members list

Value members

Concrete methods

def chooseParam(param: Alternatives, invalidInput: Option[String], needHelp: Boolean): IO[WizardException, (List[String], Parameter)]

Allows the user choosing between different options represented by Alternatives trait.

Allows the user choosing between different options represented by Alternatives trait.

Attributes

Entry point for Wizard mode.

Entry point for Wizard mode.

Attributes

def generateParams(command: Parameter): IO[WizardException, List[String]]

Constructs a command interacting with the user.

Constructs a command interacting with the user.

Attributes

def inputParam(param: Input, invalidInput: Option[String], needHelp: Boolean): IO[WizardException, List[String]]

Allows the user enterin the value of a parameter represented by Input trait.

Allows the user enterin the value of a parameter represented by Input trait.

Attributes

def printFinalCommand(params: List[String]): ZIO[Any, IOException, Unit]

Prints resulting command constructed by Wizard Mode.

Prints resulting command constructed by Wizard Mode.

Attributes

def printInfo(invalidInput: Option[String], instruction: String, parameter: Parameter, needHelp: Boolean): UIO[Unit]

Prints information about option, help and if an input of the user was invalid.

Prints information about option, help and if an input of the user was invalid.

Attributes

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product

Concrete fields

val printHeader: URIO[Any, Unit]
val prompt: String