/ 
Acme-CPANModules-LocalCPANMirror-0.002
River stage one • 1 direct dependent • 1 total dependent
/ Acme::CPANModules::LocalCPANMirror

NAME

Acme::CPANModules::LocalCPANMirror - List of modules/tools to create a local CPAN mirror

VERSION

This document describes version 0.002 of Acme::CPANModules::LocalCPANMirror (from Perl distribution Acme-CPANModules-LocalCPANMirror), released on 2023-10-29.

DESCRIPTION

Since CPAN repository is just a hierarchy of files, you can simply use a recursive download/mirror tool over http/https/ftp. However, for additional features you can take a look at the modules in this list.

ACME::CPANMODULES ENTRIES

CPAN::Mini

Author: RJBS

This module lets you create a so-called "mini mirror", which only contains the newest release for each distribution (where CPAN might also contains previous versions of a distribution as long as the CPAN author does not clean up his previous releases). This produces a significantly smaller CPAN mirror which you can use on your PC/laptop for offline development use.

App::lcpan

Author: PERLANCAR

This application not only lets you download a CPAN mini mirror (using CPAN::Mini actually) but also index the package list and distribution metadata into a SQLite database so you can perform various queries, like list of modules/distributions/scripts of a CPAN author, or related modules using cross-mention information on modules' PODs, or various rankings.

FAQ

What is an Acme::CPANModules::* module?

An Acme::CPANModules::* module, like this module, contains just a list of module names that share a common characteristics. It is a way to categorize modules and document CPAN. See Acme::CPANModules for more details.

What are ways to use this Acme::CPANModules module?

Aside from reading this Acme::CPANModules module's POD documentation, you can install all the listed modules (entries) using cpanm-cpanmodules script (from App::cpanm::cpanmodules distribution):

% cpanm-cpanmodules -n LocalCPANMirror

Alternatively you can use the cpanmodules CLI (from App::cpanmodules distribution):

% cpanmodules ls-entries LocalCPANMirror | cpanm -n

or Acme::CM::Get:

% perl -MAcme::CM::Get=LocalCPANMirror -E'say $_->{module} for @{ $LIST->{entries} }' | cpanm -n

or directly:

% perl -MAcme::CPANModules::LocalCPANMirror -E'say $_->{module} for @{ $Acme::CPANModules::LocalCPANMirror::LIST->{entries} }' | cpanm -n

This Acme::CPANModules module also helps lcpan produce a more meaningful result for lcpan related-mods command when it comes to finding related modules for the modules listed in this Acme::CPANModules module. See App::lcpan::Cmd::related_mods for more details on how "related modules" are found.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Acme-CPANModules-LocalCPANMirror.

SOURCE

Source repository is at https://github.com/perlancar/perl-Acme-CPANModules-LocalCPANMirror.

SEE ALSO

Acme::CPANModules - about the Acme::CPANModules namespace

cpanmodules - CLI tool to let you browse/view the lists

Acme::CPANModules::CustomCPAN

Acme::CPANModules::LocalCPANIndex

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) 2023, 2019 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=Acme-CPANModules-LocalCPANMirror

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.