Table of Contents - cri-2.15.12 Documentation
Pages
- LICENSE
- NEWS
-
README
- Cri
- Requirements
- Compatibility policy
- Usage
- General command metadata
- Command-line options
- Forbidden, required, and optional arguments (
argument:
) - Transforming options (
transform:
) - Options with default values (
default:
) - Multivalued options (
multiple:
) - Skipping option parsing
- Argument parsing
- Allowing arbitrary arguments
- Forbidding any arguments
- The run block
- The command runner
- Subcommands
- Loading commands from separate files
- Automatically inferring command names
- Contributors
Classes and Modules
- Cri
- Cri::ArgumentList
- Cri::ArgumentList::ArgumentCountMismatchError
- Cri::Command
- Cri::Command::CriExitException
- Cri::Command::ParserPartitioningDelegate
- Cri::CommandDSL
- Cri::CommandDSL::AlreadySpecifiedAsNoParams
- Cri::CommandDSL::AlreadySpecifiedWithParams
- Cri::CommandRunner
- Cri::Error
- Cri::HelpRenderer
- Cri::NoHelpAvailableError
- Cri::NotImplementedError
- Cri::OptionDefinition
- Cri::ParamDefinition
- Cri::Parser
- Cri::Parser::IllegalOptionError
- Cri::Parser::IllegalOptionValueError
- Cri::Parser::OptionRequiresAnArgumentError
- Cri::Platform
- Cri::StringFormatter
Methods
- ::color? — Cri::Platform
- ::define — Cri::Command
- ::load_file — Cri::Command
- ::new — Cri::ArgumentList
- ::new — Cri::ArgumentList::ArgumentCountMismatchError
- ::new — Cri::Command
- ::new — Cri::Command::CriExitException
- ::new — Cri::CommandDSL
- ::new — Cri::CommandDSL::AlreadySpecifiedAsNoParams
- ::new — Cri::CommandDSL::AlreadySpecifiedWithParams
- ::new — Cri::CommandRunner
- ::new — Cri::HelpRenderer
- ::new — Cri::OptionDefinition
- ::new — Cri::ParamDefinition
- ::new — Cri::Parser
- ::new — Cri::Parser::IllegalOptionValueError
- ::new_basic_help — Cri::Command
- ::new_basic_root — Cri::Command
- ::windows? — Cri::Platform
- #<=> — Cri::Command
- #[] — Cri::ArgumentList
- #add_argument — Cri::Parser
- #add_command — Cri::Command
- #add_defaults — Cri::Command
- #add_option — Cri::Parser
- #aliases — Cri::CommandDSL
- #all_opt_defns — Cri::Command
- #append_description — Cri::HelpRenderer
- #append_option_group — Cri::HelpRenderer
- #append_options — Cri::HelpRenderer
- #append_subcommands — Cri::HelpRenderer
- #append_summary — Cri::HelpRenderer
- #append_usage — Cri::HelpRenderer
- #argument_added — Cri::Command::ParserPartitioningDelegate
- #be_hidden — Cri::CommandDSL
- #bold — Cri::StringFormatter
- #call — Cri::CommandRunner
- #command_named — Cri::Command
- #commands_named — Cri::Command
- #default_subcommand — Cri::CommandDSL
- #define_command — Cri::Command
- #description — Cri::CommandDSL
- #each — Cri::ArgumentList
- #error? — Cri::Command::CriExitException
- #find_option_value — Cri::Parser
- #flag — Cri::CommandDSL
- #fmt — Cri::HelpRenderer
- #forbidden — Cri::CommandDSL
- #format_as_command — Cri::StringFormatter
- #format_as_option — Cri::StringFormatter
- #format_as_title — Cri::StringFormatter
- #format_opt_defn — Cri::HelpRenderer
- #formatted_name — Cri::OptionDefinition
- #gen_argument_list — Cri::Parser
- #global_option_definitions — Cri::Command
- #green — Cri::StringFormatter
- #handle_dash_option — Cri::Parser
- #handle_dashdash — Cri::Parser
- #handle_dashdash_option — Cri::Parser
- #handle_errors_while — Cri::Command
- #handle_options — Cri::Command
- #help — Cri::Command
- #key_for — Cri::Parser
- #length_for_opt_defns — Cri::HelpRenderer
- #load — Cri::ArgumentList
- #long_value_postfix_for — Cri::HelpRenderer
- #method_missing — Cri::ArgumentList
- #modify — Cri::Command
- #name — Cri::CommandDSL
- #no_params — Cri::CommandDSL
- #opt — Cri::CommandDSL
- #option — Cri::CommandDSL
- #option_added — Cri::Command::ParserPartitioningDelegate
- #optional — Cri::CommandDSL
- #param — Cri::CommandDSL
- #partition — Cri::Command
- #red — Cri::StringFormatter
- #render — Cri::HelpRenderer
- #required — Cri::CommandDSL
- #respond_to_missing? — Cri::ArgumentList
- #run — Cri::Command
- #run — Cri::CommandDSL
- #run — Cri::CommandRunner
- #run — Cri::Parser
- #run_this — Cri::Command
- #runner — Cri::CommandDSL
- #running? — Cri::Parser
- #short_value_postfix_for — Cri::HelpRenderer
- #skip_option_parsing — Cri::CommandDSL
- #stop — Cri::Parser
- #subcommand — Cri::CommandDSL
- #summary — Cri::CommandDSL
- #to_h — Cri::OptionDefinition
- #to_paragraphs — Cri::StringFormatter
- #transform_value — Cri::Parser
- #usage — Cri::CommandDSL
- #wrap_and_indent — Cri::StringFormatter
- #yellow — Cri::StringFormatter