view release on metacpan or  search on metacpan

lib/App/Dochazka/CLI.pm  view on Meta::CPAN

=head1 NAME

App::Dochazka::CLI - Dochazka command line client



=head1 VERSION

Version 0.240

=cut

our $VERSION = '0.240';



=head1 SYNOPSIS

Dochazka command line client.

    bash$ dochazka-cli
    Dochazka(2014-08-08) demo> 



=head1 DESCRIPTION

L<App::Dochazka::CLI> is the Command Line Interface (CLI) component of the
Dochazka Attendance & Time Tracking system. 

In order to work, the CLI must be pointed at a running L<App::Dochazka::REST>
(i.e., Dochazka REST server) instance by setting the C<< MREST_CLI_URI_BASE >>
meta configuration parameter. 

Detailed documentation covering configuration, deployment, and the commands
that can be used with the CLI can be found in L<App::Dochazka::CLI::Guide>.

This module is used to store some "global" package variables that are used
throughout the CLI code base.


=head1 PACKAGE VARIABLES AND EXPORTS

=over

=item * C<< $current_emp >>

The L<App::Dochazka::Common::Model::Employee> object of the current employee.

=item * C<< $current_priv >>

The privlevel of the current employee.

=item * C<< $debug_mode >>

Tells parser whether to display debug messages

=item * C<< $prompt_century >>

The century component of C<< $prompt_date >>; see L<App::Dochazka::CLI::Util>

=item * C<< $prompt_date >>

The date displayed in the prompt -- see C<bin/dochazka-cli> and L<App::Dochazka::CLI::Util>

=item * C<< $prompt_day >>

The day component of C<< $prompt_date >>; see L<App::Dochazka::CLI::Util>

=item * C<< $prompt_month >>

The month component of C<< $prompt_date >>; see L<App::Dochazka::CLI::Util>

=item * C<< $prompt_year >>

The year component of C<< $prompt_date >>; see L<App::Dochazka::CLI::Util>

=back

=cut

our @EXPORT_OK = qw( 
    $current_emp 
    $current_priv 
    $debug_mode
    $prompt_century
    $prompt_date 
    $prompt_day
    $prompt_month
    $prompt_year
);
our ( 
    $current_emp, 
    $current_priv, 
    $debug_mode, 
    $prompt_date, 
    $prompt_century, 
    $prompt_year, 
    $prompt_month, 
    $prompt_day, 
);

1;