NAME
App::ParseCommandLineUtils - CLIs for parsing command-line
VERSION
This document describes version 0.001 of App::ParseCommandLineUtils
(from Perl distribution App-ParseCommandLineUtils), released on
2022-11-04.
DESCRIPTION
This distribution includes the following command-line utilities:
* parse-command-line
FUNCTIONS
parse_command_line
Usage:
parse_command_line(%args) -> [$status_code, $reason, $payload, \%result_meta]
Parse a command-line using one of the Perl command-line parsing modules.
This is mainly for testing.
This function is not exported.
Arguments ('*' denotes required arguments):
* cmdline* => *str*
You can also feed command-line from standard input, to avoid having
to escape if specified as shell argument.
* module => *str* (default: "Text::ParseWords")
(No description)
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)
HOMEPAGE
Please visit the project's homepage at
<https://metacpan.org/release/App-ParseCommandLineUtils>.
SOURCE
Source repository is at
<https://github.com/perlancar/perl-App-ParseCommandLineUtils>.
SEE ALSO
Bencher::Scenario::CmdLineParsingModules
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTING
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.
COPYRIGHT AND LICENSE
This software is copyright (c) 2022 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
BUGS
Please report any bugs or feature requests on the bugtracker website
<https://rt.cpan.org/Public/Dist/Display.html?Name=App-ParseCommandLineU
tils>
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.