View Source Clik.CommandEnvironment (Clik v0.2.2)

Link to this section Summary

Types

Individual options used to configure a Clik.CommandEnvironment

t()

Script name, parsed options, and arguments

Link to this section Types

@type opt() ::
  {:option, [] | [Clik.Option.t()]}
  | {:arguments, [] | [String.t()]}
  | {:input, IO.device()}
  | {:output, IO.device()}
  | {:error, IO.device()}

Individual options used to configure a Clik.CommandEnvironment

@type opts() :: [] | [opt()]
@type t() :: %Clik.CommandEnvironment{
  arguments: [] | [String.t()],
  error: term(),
  input: term(),
  options: [] | [Clik.Option.t()],
  output: term(),
  script: String.t() | nil
}

Script name, parsed options, and arguments

Link to this section Functions

Link to this function

new(script_name \\ Platform.script_name(), opts \\ [])

View Source (since 0.1.0)
@spec new(String.t(), opts()) :: t()

Creates a new Clik.CommandEnvironment instance.

Input, output, and error default to stdin, stdout, and stderr respectively.