| PackageDescription | MooseX-App is a highly customisable helper to write user-friendly command
line applications without having to worry about most of the annoying things
usually involved. Just take any existing Moose class, add a single line
('use MooseX-App qw(PluginA PluginB ...);') and create one class for each
command in an underlying namespace. Options and positional parameters can
be defined as simple Moose accessors using the 'option' and 'parameter'
keywords respectively.
MooseX-App will then
* * Find, load and initialise the command classes (see
MooseX::App::Simple for single class/command applications)
* * Create automated help and documentation from modules POD as well as
attributes metadata and type constraints
* * Read, encode and validate the command line options and positional
parameters entered by the user from @ARGV and %ENV (and possibly prompt
the user for additional parameters see MooseX::App::Plugin::Term)
* * Provide helpful error messages if user input cannot be validated
(either missing or wrong attributes or Moose type constraints not
satisfied)
or if the user requests help.
Commandline options are defined using the 'option' keyword which accepts
the same attributes as Moose' 'has' keyword.
option 'some_option' => (
is => 'rw',
isa => 'Str',
);
This is equivalent to
has 'some_option' => (
is => 'rw',
isa => 'Str',
traits => ['AppOption'], # Load extra metaclass
cmd_type => 'option', # Set attribute type
);
Single letter options are treated as flags and may be combined with
eachother. However such options must have a Boolean type constraint.
option 'verbose' => (
is => 'rw',
isa => 'Bool',
cmd_flag => 'v',
);
Positional parameters are defined with the 'parameter' keyword
parameter 'some_option' => (
is => 'rw',
isa => 'Str',
);
This is equivalent to
has 'some_option' => (
is => 'rw',
isa => 'Str',
traits => ['AppOption'],
cmd_type => 'parameter',
);
All keywords are imported by Moosex::App (in the app base class) and
MooseX::App::Command (in the command class) or MooseX::App::Simple (single
class application).
Furthermore, all options and parameters can also be supplied via %ENV
option 'some_option' => (
is => 'rw',
isa => 'Str',
cmd_env => 'SOME_OPTION', # sets the env key
);
Moose type constraints help MooseX::App to construct helpful error messages
and parse @ARGV in a meaningful way. The following type constraints are
supported:
* * ArrayRef: Specify multiple values ('--opt value1 --opt value2',
also see app_permute and cmd_split)
* * HashRef: Specify multiple key value pairs ('--opt key=value --opt
key2=value2', also see app_permute)
* * Enum: Display all possibilities
* * Bool: Flags that do not require values
* * Int, Num: Used for proper error messages
Read the Tutorial for getting started with a simple MooseX::App command
line application. |