App::CLI::Command - Base class for App::CLI commands


App-CLI documentation  | view source Contained in the App-CLI distribution.

Index


NAME

Top

App::CLI::Command - Base class for App::CLI commands

SYNOPSIS

Top

    package MyApp::List;
    use base qw(App::CLI::Command);

    use constant options => (
        'verbose'   => 'verbose',
        'n|name=s'  => 'name',
    );

    sub run {
        my ( $self, $arg ) = @_;

        print "verbose" if $self->{verbose};

        my $name = $self->{name}; # get arg following long option --name

        # any thing your want this command do
    }

    # See App::CLI for information of how to invoke (sub)command.

DESCRIPTION

Top

subcommand()

    return old genre subcommand of $self;

cascading()

return instance of cascading subcommand invoked if it was listed in your constant subcommands.

cascadable()

return package name of subcommand if the subcommand invoked is in you constant subcommands

otherwise, return undef

brief_usage ($file)

Display an one-line brief usage of the command object. Optionally, a file could be given to extract the usage from the POD.

usage ($want_detail)

Display usage. If $want_detail is true, the DESCRIPTION section is displayed as well.

loc_text $text

Localizes the body of (formatted) text in $text, and returns the localized version.

filename

Return the filename for the command module.

SEE ALSO

Top

App::CLI Getopt::Long

AUTHORS

Top

Chia-liang Kao <clkao@clkao.org> Cornelius Lin <cornelius.howl@gmail.com> shelling <navyblueshellingford@gmail.com>

COPYRIGHT

Top


App-CLI documentation  | view source Contained in the App-CLI distribution.