class Opal::CLI::Context

• Opal::CLI::Context
• Reference
• Object

Overview

Context passed into command run blocks containing resolved arguments and flags.

Defined in:

Constructors

• .new(flags : Hash(Symbol, Bool) = Hash(Symbol, Bool).new, options : Hash(Symbol, Array(String) | Bool | Float64 | Int32 | String | Nil) = Hash(Symbol, OptionValue).new, args : Array(String) = Array(String).new, named_args : Hash(Symbol, String) = Hash(Symbol, String).new, named_arg_lists : Hash(Symbol, Array(String)) = Hash(Symbol, Array(String)).new, raw_args : Array(String) = Array(String).new)

Instance Method Summary

• #[](name : Symbol) : OptionValue

  Retrieves an option by name

• #[]?(name : Symbol) : OptionValue
• #arg(name : Symbol) : String | Nil

  Retrieves a positional argument by name

• #arg!(name : Symbol) : String
• #arg_list(name : Symbol) : Array(String)

  Retrieves an array of positional arguments for variadic definitions

• #arg_list : Array(String)

  Retrieves all variadic or positional arguments without specifying a name

• #args : Array(String)
• #array(name : Symbol) : Array(String)

  Strongly-typed array getter

• #flag?(name : Symbol) : Bool

  Returns true if flag was specified

• #flags : Hash(Symbol, Bool)
• #float(name : Symbol) : Float64
• #float?(name : Symbol) : Float64 | Nil

  Strongly-typed float getter

• #int(name : Symbol) : Int32
• #int?(name : Symbol) : Int32 | Nil

  Strongly-typed int getter

• #named_arg_lists : Hash(Symbol, Array(String))
• #named_args : Hash(Symbol, String)
• #options : Hash(Symbol, OptionValue)
• #pipe? : Bool

  Returns true if STDIN is piped or redirected

• #raw_args : Array(String)
• #read_input_or_arg(arg_name : Symbol | Nil = nil) : String | Nil

  Unified input reader: checks explicit argument first (file, '-', or text), and falls back to STDIN pipe if no argument was passed.

• #stdin_content : String | Nil

  Reads content from STDIN lazily and caches the result

• #string(name : Symbol) : String
• #string?(name : Symbol) : String | Nil

  Strongly-typed string getter

Constructor Detail

Instance Method Detail