Module: GLI

Includes:

App

Defined in:

lib/gli.rb,
lib/gli/app.rb,
lib/gli/dsl.rb,
lib/gli/flag.rb,
lib/gli/switch.rb,
lib/gli/command.rb,
lib/gli/options.rb,
lib/gli/version.rb,
lib/gli/argument.rb,
lib/gli/terminal.rb,
lib/gli/exceptions.rb,
lib/gli/app_support.rb,
lib/gli/commands/doc.rb,
lib/gli/commands/help.rb,
lib/gli/command_finder.rb,
lib/gli/command_support.rb,
lib/gli/commands/scaffold.rb,
lib/gli/gli_option_parser.rb,
lib/gli/command_line_token.rb,
lib/gli/command_line_option.rb,
lib/gli/commands/initconfig.rb,
lib/gli/option_parser_factory.rb,
lib/gli/option_parsing_result.rb,
lib/gli/gli_option_block_parser.rb,
lib/gli/commands/compound_command.rb,
lib/gli/commands/rdoc_document_listener.rb,
lib/gli/commands/help_modules/text_wrapper.rb,
lib/gli/commands/help_modules/command_finder.rb,
lib/gli/commands/help_modules/list_formatter.rb,
lib/gli/commands/help_modules/one_line_wrapper.rb,
lib/gli/commands/help_modules/tty_only_wrapper.rb,
lib/gli/commands/help_modules/verbatim_wrapper.rb,
lib/gli/commands/help_modules/options_formatter.rb,
lib/gli/commands/help_modules/arg_name_formatter.rb,
lib/gli/commands/help_modules/global_help_format.rb,
lib/gli/commands/help_modules/command_help_format.rb,
lib/gli/commands/help_modules/help_completion_format.rb,
lib/gli/commands/help_modules/full_synopsis_formatter.rb,
lib/gli/commands/help_modules/compact_synopsis_formatter.rb,
lib/gli/commands/help_modules/terminal_synopsis_formatter.rb

Defined Under Namespace

Modules: App, AppSupport, CommandSupport, Commands, DSL, StandardException Classes: AmbiguousCommand, Argument, BadCommandLine, BadCommandOptionsOrArguments, Command, CommandException, CommandFinder, CommandLineOption, CommandLineToken, CommandOptionBlockParser, CustomExit, Flag, GLIOptionBlockParser, GLIOptionParser, InitConfig, LegacyCommandOptionBlockParser, MissingRequiredArgumentsException, MissingRequiredOptionsException, OptionParserFactory, OptionParsingResult, Options, PreconditionFailed, RequestHelp, Switch, Terminal, UnknownCommand, UnknownCommandArgument, UnknownGlobalArgument

Constant Summary

VERSION =

'2.22.0'

Class Method Summary

• .included(klass) ⇒ Object
• .run(*args) ⇒ Object

Methods included from App

#accept, #arguments, #around, #autocomplete_commands, #commands_from, #config_file, #default_command, #exit_now!, #help_now!, #hide_commands_without_desc, #on_error, #post, #pre, #preserve_argv, #program_desc, #program_long_desc, #program_name, #skips_around, #skips_post, #skips_pre, #sort_help, #subcommand_option_handling, #synopsis_format, #use_openstruct, #version, #wrap_help_text

Methods included from AppSupport

#accepts, #argument_handling_strategy, #around_blocks, #autocomplete, #clear_nexts, #commands, #commands_declaration_order, #config_file_name, #context_description, #error_device=, #exe_name, #flags, #get_default_command, #help_sort_type, #help_text_wrap_type, #override_command_defaults, #override_default, #override_defaults_based_on_config, #parse_config, #post_block, #pre_block, #reset, #run, #stderr, #subcommand_option_handling_strategy, #switches, #synopsis_format_type, #version_string

Methods included from DSL

#arg, #arg_name, #clear_nexts, #command, #command_missing, #default_value, #desc, #flag, #flags_declaration_order, #long_desc, #switch, #switches_declaration_order

Class Method Details

.included(klass) ⇒ Object

# File 'lib/gli.rb', line 28

def self.included(klass)
  warn "You should include GLI::App instead"
end

.run(*args) ⇒ Object

# File 'lib/gli.rb', line 32

def self.run(*args)
  warn "GLI.run no longer works for GLI-2, you must just call `run(ARGV)' instead"
  warn "either fix your app, or use the latest GLI in the 1.x family"
  1
end