Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

Manual Reference Pages  -  MOOX::OPTIONS (3)

.ds Aq ’


MooX::Options - Explicit Options eXtension for Object Class



version 4.008


Create a command line tool with your Mo, Moo, Moose objects.

Everything is explicit. You have an option keyword to replace the usual has to explicitly use your attribute into the command line.

The option keyword takes additional parameters and uses Getopt::Long::Descriptive to generate a command line tool.


In :

  package myOptions;
  use Moo;
  use MooX::Options;
  option show_this_file => (
      is => ro,
      format => s,
      required => 1,
      doc => the file to display

In :

  use feature say;
  use myOptions;
  use Path::Class;
  my $opt = myOptions->new_with_options;
  say "Content of the file : ",

To use it :

  perl --show_this_file=myFile.txt
  Content of the file: myFile content

The help message :

  perl --help
  USAGE: [-h] [long options...]
      --show_this_file: String
          the file to display
      -h --help:
          show this help message
          show the manual

The usage message :

  perl --usage
  USAGE: [ --show_this_file=String ] [ --usage ] [ --help ] [ --man ]

The manual :

  perl --man


The list of the methods automatically imported into your class.


It will parse your command line params and your inline params, validate and call the new method.

  myTool --str=ko

  t->new_with_options()->str # ko
  t->new_with_options(str => ok)->str #ok


The option keyword replaces the has method and adds support for special options for the command line only.

See OPTION PARAMETERS for the documentation.

    options_usage | --help

It displays the usage message and returns the exit code.

  my $t = t->new_with_options();
  my $exit_code = 1;
  my $pre_message = "str is not valid";
  $t->options_usage($exit_code, $pre_message);

This method is also automatically fired if the command option --help is passed.

  myTool --help

    options_man | --man

It displays the manual.

  my $t = t->new_with_options();

This is automatically fired if the command option --man is passed.

  myTool --man

    options_short_usage | --usage

It displays a short version of the help message.

  my $t = t->new_with_options();

This is automatically fired if the command option --usage is passed.

  myTool --usage


The list of parameters supported by MooX::Options.


Passes extra arguments for Getopt::Long::Descriptive. It is useful if you want to configure Getopt::Long.

  use MooX::Options flavour => [qw( pass_through )];

Any flavour is passed to Getopt::Long as a configuration, check the doc to see what is possible.


By default, @ARGV is protected. If you want to do something else on it, use this option and it will change the real @ARGV.

  use MooX::Options protect_argv => 0;


If you have Role with options and you want to deactivate some of them, you can use this parameter. In that case, the option keyword will just work like an has.

  use MooX::Options skip_options => [qw/multi/];


By default, arguments passed to new_with_options have a higher priority than the command line options.

This parameter will give the command line an higher priority.

  use MooX::Options prefer_commandline => 1;


This parameter will load MooX::ConfigFromFile in your module. The config option will be used between the command line and parameters.

myTool :

  use MooX::Options with_config_from_file => 1;

In /etc/myTool.json

  {"test" : 1}


The keyword option extend the keyword has with specific parameters for the command line.

    doc | documentation

Documentation for the command line option.


Documentation for the man page. By default the doc parameter will be used.

See also Man parameters to get more examples how to build a nice man page.


This attribute indicates that the parameter is mandatory. This attribute is not really used by MooX::Options but ensures that consistent error message will be displayed.


Format of the params, same as Getopt::Long::Descriptive.
o i : integer
o i@: array of integer
o s : string
o s@: array of string
o f : float value
By default, it’s a boolean value.

Take a look of available formats with Getopt::Long::Descriptive.

You need to understand that everything is explicit here. If you use Moose and your attribute has isa => Array[Int], that will <B>notB> imply the format i@.

    format json : special format support

The parameter will be treated like a json string.

  option hash => (is => ro, json => 1);

  myTool --hash={"a":1,"b":2} # hash = { a => 1, b => 2 }


It adds the negative version for the option.

  option verbose => (is => ro, negativable => 1);

  myTool --verbose    # verbose = 1
  myTool --no-verbose # verbose = 0


It appends to the format the array attribute @.

I advise to add a default value to your attribute to always have an array. Otherwise the default value will be an undefined value.

  option foo => (is => rw, format => s@, default => sub { [] });

  myTool --foo="abc" --foo="def" # foo = ["abc", "def"]


For repeatable option, you can add the autosplit feature with your specific parameters.

  option test => (is => ro, format => i@, default => sub {[]}, autosplit => ,);
  myTool --test=1 --test=2 # test = (1, 2)
  myTool --test=1,2,3      # test = (1, 2, 3)

It will also handle quoted params with the autosplit.

  option testStr => (is => ro, format => s@, default => sub {[]}, autosplit => ,);

  myTool --testStr=a,b,"c,d",e,f # testStr ("a", "b", "c,d", "e", "f")


Long option can also have short version or aliased.

  option verbose => (is => ro, short => v);

  myTool --verbose # verbose = 1
  myTool -v        # verbose = 1

  option account_id => (is => ro, format => i, short => a|id);

  myTool --account_id=1
  myTool -a=1
  myTool --id=1

You can also use a shorter option without attribute :

  option account_id => (is => ro, format => i);

  myTool --acc=1
  myTool --account=1


Specifies the order of the attribute. If you want to push some attributes at the end of the list. By default all options have an order set to 0, and options are sorted by their names.

  option at_the_end => (is => ro, order => 999);


o Man parameters
o Using namespace::clean
o Manage your tools with MooX::Cmd


o Slide3D about MooX::Options <>


Matt S. Trout (mst) <> : For his patience and advice.
Tomas Doran (t0m) <> : To help me release the new version, and using it :)
Torsten Raudssus (Getty) : to use it a lot in DuckDuckGo <> (go to see MooX module also)
Jens Rehsack (REHSACK) : Use with PkgSrc <>, and many really good idea (MooX::Cmd, MooX::ConfigFromFile, and more to come I’m sure)


Please report any bugs or feature requests on the bugtracker website

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.


celogeek <>


This software is copyright (c) 2013 by celogeek <>.

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

Search for    or go to Top of page |  Section 3 |  Main Index

perl v5.20.3 MOOX::OPTIONS (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.