NAME

App::lcpan::Cmd::modules - List modules/packages

VERSION

This document describes version 1.062 of App::lcpan::Cmd::modules (from Perl distribution App-lcpan), released on 2020-08-13.

FUNCTIONS

handle_cmd

Usage:

 handle_cmd(%args) -> [status, msg, payload, meta]

List modules/packages.

This function is not exported.

Arguments ('*' denotes required arguments):

• added_or_updated_since => date

  Include only records that are added/updated since a certain date.

• added_or_updated_since_last_index_update => true

  Include only records that are added/updated since the last index update.

• added_or_updated_since_last_n_index_updates => posint

  Include only records that are added/updated since the last N index updates.

• added_since => date

  Include only records that are added since a certain date.

• added_since_last_index_update => true

  Include only records that are added since the last index update.

• added_since_last_n_index_updates => posint

  Include only records that are added since the last N index updates.

• author => str

  Filter by author.

• cpan => dirname

  Location of your local CPAN mirror, e.g. /path/to/cpan.

  Defaults to ~/cpan.

• detail => bool

• dist => perl::distname

  Filter by distribution.

• include_core => bool (default: 1)

  Include core modules.

• include_noncore => bool (default: 1)

  Include non-core modules.

• index_name => filename (default: "index.db")

  Filename of index.

  If index_name is a filename without any path, e.g. index.db then index will be located in the top-level of cpan. If index_name contains a path, e.g. ./index.db or /home/ujang/lcpan.db then the index will be located solely using the index_name.

• latest => bool

• namespaces => array[perl::modname]

  Select modules belonging to certain namespace(s).

• or => bool

  When there are more than one query, perform OR instead of AND logic.

• perl_version => str (default: "v5.30.0")

  Set base Perl version for determining core modules.

• query => array[str]

  Search query.

• query_type => str (default: "any")

• sort => array[str] (default: ["module"])

  Sort the result.

• updated_since => date

  Include only records that are updated since certain date.

• updated_since_last_index_update => true

  Include only records that are updated since the last index update.

• updated_since_last_n_index_updates => posint

  Include only records that are updated since the last N index updates.

• use_bootstrap => bool (default: 1)

  Whether to use bootstrap database from App-lcpan-Bootstrap.

  If you are indexing your private CPAN-like repository, you want to turn this off.

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)

By default will return an array of package names. If you set detail to true, will return array of records.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-lcpan.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-lcpan.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-lcpan

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2019, 2018, 2017, 2016, 2015 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.