class Opal::CLI::Option

• Opal::CLI::Option
• Reference
• Object

Overview

Represents a command-line flag or option.

Defined in:

Constructors

• .from_spec(name : Symbol, spec : String, description : String = "", type : Symbol | Nil = nil, default : OptionValue = nil, required : Bool = false, global : Bool = false, choices : Array(String) | Nil = nil, env_var : String | Nil = nil, group : String | Nil = nil) : Option

  Parses a unified spec string like "-d, --delimiter=CHAR" or "-z, --zebra"

• .new(name : Symbol, long : String, short : String | Nil = nil, description : String = "", type : Symbol = :string, default : OptionValue = nil, required : Bool = false, global : Bool = false, choices : Array(String) | Nil = nil, env_var : String | Nil = nil, group : String | Nil = nil, value_name : String | Nil = nil)

Instance Method Summary

• #choices : Array(String) | Nil
• #default : OptionValue
• #description : String
• #env_var : String | Nil
• #flag? : Bool
• #formatted_flag : String

  Formatted flag representation for help screens (e.g.

• #global? : Bool
• #group : String | Nil
• #group=(group : String | Nil)
• #long : String
• #long_name : String

  Alias for long

• #name : Symbol
• #required? : Bool
• #short : String | Nil
• #short_name : String | Nil

  Alias for short

• #type : Symbol
• #value_name : String | Nil

Constructor Detail

Instance Method Detail