=head1 NAME

App::Console::CommandScript - 

=head1 SYNOPSIS


  #!/usr/bin/perl -w
    
  package Local::App;
  use strict;
  use Data::OrderedHash;
  use base 'App::Console::CommandScript';
    
  our %USAGE = ();
    
  sub new {
    my $self = shift->SUPER::new();
    $self;
  }
    
  $USAGE{'test'} = {
    summary => 'My test command',
    params => Data::OrderedHash->new(
      '<param>' => 'This is a required parameter',
      '-foo' => 'This is an option',
    ),
  };
    
  sub test {
    my $self = shift;
    my $opts = my_opts(\@_);
    my $param = shift;
    my $foo = $opts->{foo} || 'unset';
    $self->printf("You passed in '%s' and -foo is '%s'\n", $param, $foo)
  };
    
  1;
    
  package main;
  Local::App->new()->exec(@ARGV);



=head1 EXPORTS

Nothing exported by default

=over



=back

=head1 DEPENDENCIES

This module requires these other modules and libraries:

    Error
    Error::Simple
    Error::Programatic
    Perl::Module
    Data::Hub::Util
    App::Console::Color

=head1 DESCRIPTION


This package faciltates writing command-line scripts.  The base class method 
C<exec> looks to your package for the C<%USAGE> hash to display command usage 
and glean the required syntax.  A command is simply a method which exists in 
your package.

If the above example were placed in an executable file name 'mycmd.pl', then:

  $ ./mycmd.pl
    
  usage:
    mycmd.pl -help [command]
    mycmd.pl <command> [arguments] [options]
  commands:
    test       My test command
    
  $ ./mycmd.pl -help test
    
  usage:
    mycmd.pl test <param> [options]
  where:
    <param>    This is a required parameter
  options:
    -quiet     Suppress errors and warnings
    -foo       This is an option

Notice the global option C<-quiet> which affects the base methods

  print
  printf
  err_print
  err_printf
  fail




=head1 PUBLIC INTERFACE

=head2 exec

=over

=item Invoke the subroutine in the derived class, or display help






=back


=head2 warn

=over

=item Print to STDERR (unless -quiet)






=back


=head2 print

=over

=item Print to STDOUT (unless -quiet)






=back


=head2 printf

=over

=item Print formatted output to STDOUT (unless -quiet)



C<$spec> may contain color conversions (See L<App::Console::Color>)



=back


=head2 err_print

=over

=item Print to STDERR (unless -quiet)






=back


=head2 err_printf

=over

=item Print formatted output to STDERR (unless -quiet)



C<$spec> may contain color conversions (See L<App::Console::Color>)



=back


=head2 fail

=over

=item Exit the program with an optional message



When C<@messages> are provided (and not C<-quiet>), C<die> is called and help
verbiage is appened. Otherwise C<exit> is called with a value of C<1>.



=back


=head2 quit

=over

=item Exit the program (not trappable) with an optional message



The C<@messages> are not written to STDERR if C<-quiet> is enabled.



=back




=head1 AUTHORS

    Ryan Gies <ryangies@cpan.org>

=head1 COPYRIGHT

    Copyright (C) 2014-2016 by Ryan Gies. All rights reserved.
    Copyright (C) 2006-2013 by Livesite Networks, LLC. All rights reserved.
    Copyright (C) 2000-2005 by Ryan Gies. All rights reserved.
    Redistribution and use in source and binary forms, with or without 
    modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright notice, 
    this list of conditions and the following disclaimer.
    * The origin of this software must not be misrepresented; you must not 
    claim that you wrote the original software. If you use this software in a 
    product, an acknowledgment in the product documentation would be 
    appreciated but is not required.
    * Altered source versions must be plainly marked as such, and must not be 
    misrepresented as being the original software.
    * The name of the author may not be used to endorse or promote products 
    derived from this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED 
    WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
    EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
    OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
    IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
    OF SUCH DAMAGE.
    To the best of our knowledge, no patented algorithms have been used. However, we
    do not have the resources to carry out a patent search, and therefore cannot 
    give any guarantee of the above statement.

=cut

