our $DATE = '2020-03-25'; # DATE
our $VERSION = '0.006'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any;

my $prefix = '/App/cpanmodules/';

    url => $prefix,
    subcommands => {
        'ls'         => {url=>"${prefix}list_acmemods"},
        'view'       => {url=>"${prefix}view_acmemod"},
        'get'        => {url=>"${prefix}get_acmemod"},
        'ls-entries'     => {url=>"${prefix}list_entries"},

# ABSTRACT: The Acme::CPANModules CLI
# PODNAME: cpanmodules



=encoding UTF-8

=head1 NAME

cpanmodules - The Acme::CPANModules CLI

=head1 VERSION

This document describes version 0.006 of cpanmodules (from Perl distribution App-cpanmodules), released on 2020-03-25.


Install some C<Acme::CPANModules::> modules and then ...

List all installed Acme::CPANModules modules:

 % cpanmodules ls
 % cpanmodules ls -l

Find Acme::CPANModules modules that mention a module:

 % cpanmodules ls --mentions Foo::Bar

View as rendered POD:

 % cpanmodules view PERLANCAR::Favorites

Get the list (raw):

 % cpanmodules get PERLANCAR::Favorites

List entries of a list:

 % cpanmodules ls-entries PERLANCAR::Favorites::App

Install all entries of a list:

 % cpanmodules ls-entries PERLANCAR::Favorites::App | cpanm -n


=head2 B<get>

Get contents of an Acme::CPANModules module.

=head2 B<ls>

List all installed Acme::CPANModules modules.

=head2 B<ls-entries>

List entries from an Acme::CPANModules module.

=head2 B<view>

View an Acme::CPANModules module as rendered POD.

=head1 OPTIONS

C<*> marks required options.

=head2 Common options


=item B<--config-path>=I<s>, B<-c>

Set path to configuration file.

=item B<--config-profile>=I<s>, B<-P>

Set configuration profile to use.

=item B<--format>=I<s>

Choose output format, e.g. json, text.

Default value:


=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--json>

Set output format to json.

=item B<--naked-res>

When outputing as JSON, strip result envelope.

Default value:


By default, when outputing as JSON, the full enveloped result is returned, e.g.:


The reason is so you can get the status (1st element), status message (2nd
element) as well as result metadata/extra result (4th element) instead of just
the result (3rd element). However, sometimes you want just the result, e.g. when
you want to pipe the result for more post-processing. In this case you can use
`--naked-res` so you just get:


=item B<--no-config>, B<-C>

Do not use any configuration file.

=item B<--no-env>

Do not read environment for default options.

=item B<--page-result>

Filter output through a pager.

=item B<--subcommands>

List available subcommands.

=item B<--version>, B<-v>

Display program's version and exit.


=head2 Options for subcommand get


=item B<--module>=I<s>*, B<-m>


=head2 Options for subcommand ls


=item B<--detail>, B<-l>

=item B<--mentions>=I<s>

=item B<--module>=I<s>, B<-m>


=head2 Options for subcommand ls-entries


=item B<--detail>, B<-l>

=item B<--module>=I<s>*, B<-m>

=item B<--with-attr>=I<s@>

Include additional attributes from each entry.

Can be specified multiple times.

=item B<--with-attrs-json>=I<s>

Include additional attributes from each entry (JSON-encoded).

See C<--with-attr>.


=head2 Options for subcommand view


=item B<--module>=I<s>*, B<-m>



This script has shell tab completion capability with support for several

=head2 bash

To activate bash completion for this script, put:

 complete -C cpanmodules cpanmodules

in your bash startup (e.g. F<~/.bashrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is recommended, however, that you install modules using L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.

=head2 tcsh

To activate tcsh completion for this script, put:

 complete cpanmodules 'p/*/`cpanmodules`/'

in your tcsh startup (e.g. F<~/.tcshrc>). Your next shell session will then
recognize tab completion for the command. Or, you can also directly execute the
line above in your shell to activate immediately.

It is also recommended to install L<shcompgen> (see above).

=head2 other shells

For fish and zsh, install L<shcompgen> as described above.


This script can read configuration files. Configuration files are in the format of L<IOD>, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using C<--config-path>): F<~/.config/cpanmodules.conf>, F<~/cpanmodules.conf>, or F</etc/cpanmodules.conf>.

All found files will be read and merged.

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

To put configuration for a certain subcommand only, use a section name like C<[subcommand=NAME]> or C<[SOMESECTION subcommand=NAME]>.

You can put multiple profiles in a single file by using section names like C<[profile=SOMENAME]> or C<[SOMESECTION profile=SOMENAME]> or C<[subcommand=SUBCOMMAND_NAME profile=SOMENAME]> or C<[SOMESECTION subcommand=SUBCOMMAND_NAME 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 matches.

Finally, you can 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 ...]>. If you only want a section to be read when the value of an environment variable has value equals something: C<[env=HOSTNAME=blink ...]> or C<[SOMESECTION env=HOSTNAME=blink ...]>. If you only want a section to be read when the value of an environment variable does not equal something: C<[env=HOSTNAME!=blink ...]> or C<[SOMESECTION env=HOSTNAME!=blink ...]>. If you only want a section to be read when an environment variable contains something: C<[env=HOSTNAME*=server ...]> or C<[SOMESECTION env=HOSTNAME*=server ...]>. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

=head2 Common for all subcommands

 format (see --format)
 naked_res (see --naked-res)

=head2 Configuration for subcommand get

 module (see --module)

=head2 Configuration for subcommand ls

 detail (see --detail)
 mentions (see --mentions)
 module (see --module)

=head2 Configuration for subcommand ls-entries

 detail (see --detail)
 module (see --module)
 with_attrs (see --with-attr)

=head2 Configuration for subcommand view

 module (see --module)


=head2 CPANMODULES_OPT => str

Specify additional command-line options.

=head1 FILES





Please visit the project's homepage at L<https://metacpan.org/release/App-cpanmodules>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-cpanmodules>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<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

=head1 SEE ALSO


C<Acme::CPANModules::*> modules

L<App::CPANModulesUtils> provides some other CLI's related to Acme::CPANModules.

L<lcpan> also has some subcommands (supplied by
L<App::lcpan::CmdBundle::cpanmodules>) to query Acme::CPANModules modules.

L<acme-cpanauthors> from L<App::AcmeCPANAuthors>

L<cpanauthors> from L<App::CPANAuthorsUtils>

=head1 AUTHOR

perlancar <perlancar@cpan.org>


This software is copyright (c) 2020, 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.