Perinci::CmdLine::Plugin::Run::DumpObject - Dump object mode
This document describes version 1.928 of Perinci::CmdLine::Plugin::Run::DumpObject (from Perl distribution Perinci-CmdLine-Lite), released on 2022-11-24.
A Run:: plugin is the main plugin that runs at the run event, which is fired by Perinci::CmdLine's run() method.
Multiple Run::* plugins can be registered at the run event, but only one will actually run because they return 201 code which instruct Perinci::CmdLine to end the event early.
The Run::DumpObject plugin handler first check if the PERINCI_CMDLINE_DUMP_OBJECT variable is set to a true value (containing some label e.g. foo). If not, then the handler declines.
The handler then dumps the main Perinci::CmdLine object and exits.
This mode can be used by tools like shcompgen to extract the command-line options.
Please visit the project's homepage at https://metacpan.org/release/Perinci-CmdLine-Lite.
Source repository is at https://github.com/perlancar/perl-Perinci-CmdLine-Lite.
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, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014 by perlancar <email@example.com>.
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 https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-CmdLine-Lite
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.
To install Perinci::CmdLine::Lite, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.