Class Cri::Base
In: lib/cri/base.rb
Parent: Object

Cri::Base is the central class representing a commandline tool. It has a list of commands.

Methods

add_command   command_named   global_option_definitions   handle_option   new   run   show_help  

Attributes

commands  [R]  The CLI‘s list of commands (should also contain the help command)
help_command  [RW]  The CLI‘s help command (required)

Public Class methods

new(tool_name)

Creates a new instance of the commandline tool.

Public Instance methods

add_command(command)

Adds the given command to the list of commands. Adding a command will also cause the command‘s base to be set to this instance.

command_named(name)

Returns the command with the given name.

global_option_definitions()

Returns the list of global option definitions.

handle_option(option)

Handles the given option.

run(args)

Parses the given commandline arguments and executes the requested command.

show_help(command=nil)

Shows the help text for the given command, or shows the general help text if no command is given.

[Validate]