Perinci::CmdLine::Dump - Run a Perinci::CmdLine-based script but only to dump the object


This document describes version 0.121 of Perinci::CmdLine::Dump (from Perl distribution Perinci-CmdLine-Dump), released on 2022-01-16.




 dump_pericmd_script(%args) -> [$status_code, $reason, $payload, \%result_meta]

Run a Perinci::CmdLine-based script but only to dump the object.

This function runs a CLI script that uses Perinci::CmdLine (or its variant Perinci::CmdLine::Lite or Perinci::CmdLine::Any) but monkey-patches Perinci::CmdLine::Base beforehand so that run() will dump the object and then exit. The goal is to get the object without actually running the script.

This can be used to gather information about the script and then generate documentation about it (e.g. Pod::Weaver::Plugin::Rinci to insert POD sections based on information from the Rinci metadata of the function used by the script) or do other things (e.g. App::shcompgen to generate a completion script for the original script).

CLI script needs to use Perinci::CmdLine. This is detected currently by a simple regex. If script is not detected as using Perinci::CmdLine, status 412 is returned.

Will return the Perinci::CmdLine object dump. In addition to that, if detected that script refers to function URL /main (which might mean that function metadata is embedded in the script itself and not in a separate module), will also dump the target function's metadata in func.meta in this function's result metadata.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • filename* => str

    Path to the script.

  • libs => array[str]

    Libraries to unshift to @INC when running script.

  • method => str

    The patch method is using monkey-patching to replace run() with a routine that dumps the object and exit. This has a disadvantage of exiting too early, for example some attributes like common_opts is filled during run(). Another method is self-dump that requires Perinci::CmdLine::Lite version 1.73 or later.

    The default is to use self-dump, but patch for /main/.

  • skip_detect => bool

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)


Please visit the project's homepage at


Source repository is at


perlancar <>


To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.


This software is copyright (c) 2022, 2018, 2017, 2016, 2015, 2014 by perlancar <>.

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


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.