Module: OmniCli

Defined in:

lib/omnicli.rb,
lib/omnicli/errors.rb,
lib/omnicli/parser.rb,
lib/omnicli/version.rb

Overview

The OmniCli module provides functionality to build Omni commands in Ruby.

Defined Under Namespace

Classes: ArgListMissingError, Error, InvalidBooleanValueError, InvalidFloatValueError, InvalidIntegerValueError, InvalidTypeStringError, InvalidValueError, Parser

Constant Summary

VERSION =

Read version from VERSION file, or default to 0.0.0-unreleased

if File.exist?(File.expand_path("VERSION", __dir__))
  File.read(File.expand_path("VERSION", __dir__)).strip
else
  "0.0.0-unreleased"
end

Class Method Summary

• .parse! ⇒ OpenStruct

  Create a new parser instance and parse arguments.

Class Method Details

.parse! ⇒ OpenStruct

Create a new parser instance and parse arguments

Returns:

• (OpenStruct) —

  parsed arguments

Raises:

• (ArgListMissingError) —

  if OMNI_ARG_LIST is not set

• (InvalidBooleanValueError) —

  if a boolean value is invalid

• (InvalidIntegerValueError) —

  if an integer value is invalid

• (InvalidFloatValueError) —

  if a float value is invalid

# File 'lib/omnicli.rb', line 16

def self.parse!
  Parser.new.parse!
end