Class | Clamp::Command |
In: |
lib/clamp/command.rb
|
Parent: | Object |
{Command} models a shell command. Each command invocation is a new object. Command options and parameters are represented as attributes (see {Command::Declaration}).
The main entry-point is {run}, which uses {parse} to populate attributes based on an array of command-line arguments, then calls {execute} (which you provide) to make it go.
context | [RW] | |
invocation_path | [R] | @return [String] the path used to invoke this command |
remaining_arguments | [R] | @return [Array<String>] unconsumed command-line arguments |
Create a command execution.
@param [String] invocation_path the path used to invoke the command @param [Hash] context additional data the command may need
Execute the command (assuming that all options/parameters have been set).
This method is designed to be overridden in sub-classes.
Parse command-line arguments.
@param [Array<String>] arguments command-line arguments @return [Array<String>] unconsumed arguments