App-PericmdUtils

 view release on metacpan or  search on metacpan

README  view on Meta::CPAN

         [
           200,
           "OK",
           [
             {
               name    => "Debug::DumpArgs",
               summary => "Dump command-line arguments (\$r->{args}), by default after argument validation",
               tags    => "category:debugging",
               conf    => "",
               hooks   => "after_validate_args",
               dist    => "Perinci-CmdLine-Lite",
             },
             {
               name    => "Debug::DumpR",
               summary => "Dump request stash (\$r), by default after action",
               dist    => "Perinci-CmdLine-Lite",
               conf    => "",
               hooks   => "after_action",
               tags    => "category:debugging",
             },

lib/App/PericmdUtils.pm  view on Meta::CPAN

 [
   200,
   "OK",
   [
     {
       name    => "Debug::DumpArgs",
       summary => "Dump command-line arguments (\$r->{args}), by default after argument validation",
       tags    => "category:debugging",
       conf    => "",
       hooks   => "after_validate_args",
       dist    => "Perinci-CmdLine-Lite",
     },
     {
       name    => "Debug::DumpR",
       summary => "Dump request stash (\$r), by default after action",
       dist    => "Perinci-CmdLine-Lite",
       conf    => "",
       hooks   => "after_action",
       tags    => "category:debugging",
     },

script/detect-pericmd-script  view on Meta::CPAN

All found files will be read and merged.

To disable searching for configuration files, pass C<--no-config>.

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.

You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program match...

You can also filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...

To load and configure plugins, you can use either the C<-plugins> parameter (e.g. C<< -plugins=DumpArgs >> or C<< -plugins=DumpArgs@before_validate_args >>), or use the C<[plugin=NAME ...]> sections, for example:

 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
 
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2

 

which is equivalent to setting C<< -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2 >>.

List of available configuration parameters:

 filename (see --filename)
 format (see --format)
 include_noexec (see --exclude-noexec)
 naked_res (see --naked-res)
 string (see --string)

=head1 ENVIRONMENT

script/dump-pericmd-script  view on Meta::CPAN

All found files will be read and merged.

To disable searching for configuration files, pass C<--no-config>.

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.

You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program match...

You can also filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...

To load and configure plugins, you can use either the C<-plugins> parameter (e.g. C<< -plugins=DumpArgs >> or C<< -plugins=DumpArgs@before_validate_args >>), or use the C<[plugin=NAME ...]> sections, for example:

 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
 
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2

 

which is equivalent to setting C<< -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2 >>.

List of available configuration parameters:

 filename (see --filename)
 format (see --format)
 libs (see --lib)
 method (see --method)
 naked_res (see --naked-res)
 skip_detect (see --skip-detect)

script/gen-pod-for-pericmd-script  view on Meta::CPAN

All found files will be read and merged.

To disable searching for configuration files, pass C<--no-config>.

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]>. Those sections will only be read if you specify the matching C<--config-profile SOMENAME>.

You can also put configuration for multiple programs inside a single file, and use filter C<program=NAME> in section names, e.g. C<[program=NAME ...]> or C<[SOMESECTION program=NAME]>. The section will then only be used when the reading program match...

You can also filter a section by environment variable using the filter C<env=CONDITION> in section names. For example if you only want a section to be read if a certain environment variable is true: C<[env=SOMEVAR ...]> or C<[SOMESECTION env=SOMEVAR ...

To load and configure plugins, you can use either the C<-plugins> parameter (e.g. C<< -plugins=DumpArgs >> or C<< -plugins=DumpArgs@before_validate_args >>), or use the C<[plugin=NAME ...]> sections, for example:

 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
 
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2

 

which is equivalent to setting C<< -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2 >>.

List of available configuration parameters:

 common_opts (see --common-opts)
 completer_script (see --completer-script)
 config_dirs (see --config-dirs)
 config_filename (see --config-filename)
 default_subcommand (see --default-subcommand)
 env_name (see --env-name)
 format (see --format)

script/list-pericmd-plugins  view on Meta::CPAN

 Run::DebugCompletion
 Run::DumpObject
 Run::Normal

Show details:

 % list-pericmd-plugins -l
 +-----------------------+--------------------------------------------------------------------------------+-----------+----------------------+------------------------+-------------------------------------------+
 | name                  | summary                                                                        | conf      | dist                 | hooks                  | tags                                      |
 +-----------------------+--------------------------------------------------------------------------------+-----------+----------------------+------------------------+-------------------------------------------+
 | Debug::DumpArgs       | Dump command-line arguments ($r->{args}), by default after argument validation |           | Perinci-CmdLine-Lite | after_validate_args    | category:debugging                        |
 | Debug::DumpR          | Dump request stash ($r), by default after action                               |           | Perinci-CmdLine-Lite | after_action           | category:debugging                        |
 | Debug::DumpRes        | Dump result ($r->{res}), by default after action                               |           | Perinci-CmdLine-Lite | after_action           | category:debugging                        |
 | Flow::Exit            | Exit program                                                                   | exit_code | Perinci-CmdLine-Lite | after_action           | category:flow-control, category:debugging |
 | Plugin::Disable       | Prevent the loading (activation) of other plugins                              | plugins   | Perinci-CmdLine-Lite | before_activate_plugin | category:plugin                           |
 | Plugin::DisablePlugin | Prevent the loading (activation) of other plugins                              | plugins   | Perinci-CmdLine-Lite | before_activate_plugin | category:plugin                           |
 | Run::Completion       | Shell completion mode                                                          |           | Perinci-CmdLine-Lite | on_run                 | category:run-handler, category:completion |
 | Run::DebugCompletion  | Debug completion                                                               | log_file  | Perinci-CmdLine-Lite | on_run                 | category:run-handler, category:debugging  |
 | Run::DumpObject       | Dump object mode                                                               |           | Perinci-CmdLine-Lite | on_run                 | category:run-handler, category:debugging  |
 | Run::Normal           | Normal run                                                                     |           | Perinci-CmdLine-Lite | on_run                 | category:run-handler                      |
 +-----------------------+--------------------------------------------------------------------------------+-----------+----------------------+------------------------+-------------------------------------------+