NAME
App::cpanmodules - The Acme::CPANModules CLI
VERSION
This document describes version 0.005 of App::cpanmodules (from Perl distribution App-cpanmodules), released on 2019-12-26.
SYNOPSIS
Use the included script cpanmodules.
OBSERVED CPANMODULES PROPERTIES/ATTRIBUTES
x.app.cpanmodules.show_entries
Boolean. Default is true. If set to false, will not show entries in the generated POD's Description.
FUNCTIONS
get_acmemod
Usage:
get_acmemod(%args) -> [status, msg, payload, meta]Get contents of an Acme::CPANModules module.
This function is not exported.
Arguments ('*' denotes required arguments):
module* => perl::modname
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
list_acmemods
Usage:
list_acmemods(%args) -> [status, msg, payload, meta]List all installed Acme::CPANModules modules.
This function is not exported.
Arguments ('*' denotes required arguments):
detail => bool
mentions => perl::modname
module => perl::modname
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
list_entries
Usage:
list_entries(%args) -> [status, msg, payload, meta]List entries from an Acme::CPANModules module.
This function is not exported.
Arguments ('*' denotes required arguments):
detail => bool
module* => perl::modname
with_attrs => array[str]
Include additional attributes from each entry.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
view_acmemod
Usage:
view_acmemod(%args) -> [status, msg, payload, meta]View an Acme::CPANModules module as rendered POD.
This function is not exported.
Arguments ('*' denotes required arguments):
module* => perl::modname
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/App-cpanmodules.
SOURCE
Source repository is at https://github.com/perlancar/perl-App-cpanmodules.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-cpanmodules
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.
SEE ALSO
App::CPANModulesUtils provides some other CLI's related to Acme::CPANModules.
lcpan also has some subcommands (supplied by App::lcpan::CmdBundle::cpanmodules) to query Acme::CPANModules modules.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2019, 2018 by 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.