App::CLI(3pm)

💖 NAME 💖

App::CLI — the dispatcher module for command line interface programs. You’re on the App::CLI(3pm) page, bestie. 💅

✨ SYNOPSIS ✨

Okay so here’s the whole group-chat receipt — literal code, typos and all, so don’t come for me:

           package MyApp;
           use base 'App::CLI';        # the DISPATCHER of your App
                                       # it's not necessary putting the dispather
                                       #  on the top level of your App

           package main;

           MyApp->dispatch;            # call dispather in where you want

           package MyApp::List;
           use base qw(App::CLI::Command); # any (SUB)COMMAND of your App

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

           use constant subcommands => qw(User Nickname type); # if you want subcommands
                                                               # automatically dispatch to subcommands
                                                               # when invoke $ myapp list [user|nickname|--type]
                                                               # note 'type' lower case in first char
                                                               # is subcommand of old genre which is deprecated

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

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

               if ($self->{help}) {
                   # if $ myapp list --help or $ $ myapp list -h
                   # just only output PODs
               } else {
                   # do something when imvoking $ my app list
                   # without subcommand and --help
               }
           }

           package MyApp::List::User;
           use base qw(App::CLI::Command);
           use constant options => (
               "h|help"  =>  "help",
           );

           sub run {
               my ($self,@args) = @_;
               # code for listing user
           }

           pakcage MyApp::List::Nickname;
           use base qw(App::CLI::Command);
           use constant options => (
               "sort=s"  =>  "sort",
           );

           sub run {
               my ($self,@args) = @_;
               # code for listing nickname
           }

           package MyApp::List::type;   # old genre of subcommand could not be cascading infinitely
           use base qw(MyApp::List);    # should inherit its parents command

           sub run {
               my ($self, @args);
               # run to here when invoking $ myapp list --type
           }

           package MyApp::Help;
           use base 'App::CLI::Command::Help';

           use constant options => (
               'verbose' => 'verbose',
           );

           sub run {
               my ($self, @arg) = @_;
               # do something
               $self->SUPER(@_); # App::CLI::Command::Help would output PDOs of each command
           }

🦋 DESCRIPTION 🦋

App::CLI dispatches CLI (command line interface) based commands into command classes. It also supports subcommand and per-command options. iconic behavior. ✨

🌸 get_opt([@config], %opt_map) 🌸

Give it an options map, and it gets processed by Getopt::Long::Parser. Cute.

🦋 interface of dispatcher 🦋

• cmd_map($cmd) — find package name of subcommand in constant %alias. If it’s finded, return ucfirst of the package name; otherwise, return ucfirst of $cmd itself.
• get_cmd($cmd, @arg) — return subcommand of first level via $ARGV[0].

💜 SEE ALSO 💜

• App::CLI::Command
• Getopt::Long

🎀 AUTHORS 🎀

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

👑 COPYRIGHT 👑

Copyright 2005-2006 by Chia-liang Kao <clkao@clkao.org>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See <http://www.perl.com/perl/misc/Artistic.html>.

---

💖 That’s the whole page, bestie — sourced from perl v5.36.0, dated 2022-10-15. Mwah! 💖