A command to be run, in context of global flags and switches
# File lib/gli/command.rb, line 60 def self.name_as_string(name) name.to_s end
Create a new command
the name or names of this command (symbol or Array of symbols)
description of this command
description of the arguments, or nil if this command doesn’t take arguments
a longer description of the command, possibly with multiple lines and text formatting
# File lib/gli/command.rb, line 14 def initialize(names,description,arguments_name=nil,long_desc=nil) super(names,description,long_desc) @arguments_description = arguments_name || '' clear_nexts end
# File lib/gli/command.rb, line 56 def action(&block) @action = block end
describe the argument name of the next flag
# File lib/gli/command.rb, line 39 def arg_name(name); @next_arg_name = name; end
# File lib/gli/command.rb, line 20 def arguments_description; @arguments_description; end
# File lib/gli/command.rb, line 64 def clear_nexts @next_desc = nil @next_arg_name = nil @next_default_value = nil end
set the default value of the next flag
# File lib/gli/command.rb, line 41 def default_value(val); @next_default_value = val; end
describe the next switch or flag
# File lib/gli/command.rb, line 37 def desc(description); @next_desc = description; end
# File lib/gli/command.rb, line 70 def execute(global_options,options,arguments) @action.call(global_options,options,arguments) end
# File lib/gli/command.rb, line 43 def flag(*names) flag = Flag.new([names].flatten,@next_desc,@next_arg_name,@next_default_value) flags[flag.name] = flag clear_nexts end
Create a switch
# File lib/gli/command.rb, line 50 def switch(*names) switch = Switch.new([names].flatten,@next_desc) switches[switch.name] = switch clear_nexts end
Generated with the Darkfish Rdoc Generator 2.