query => array[str]

Search query.

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 (result) 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 CPAN ID's. If you set detail to true, will return array of records.

List dependencies.

By default only runtime requires are displayed. To see prereqs for other phases (e.g. configure, or build, or ALL) or for other relationships (e.g. recommends, or ALL), use the --phase and --rel options.

Note that dependencies information are taken from META.json or META.yml files. Not all releases (especially older ones) contain them. lcpan (like MetaCPAN) does not extract information from Makefile.PL or Build.PL because that requires running (untrusted) code.

Also, some releases specify dynamic config, so there might actually be more dependencies.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

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

Defaults to ~/cpan .

Include Perl core modules.

Filename of index.

Recurse for a number of levels (-1 means unlimited).

Set base Perl version for determining core modules.

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 (result) 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 distributions.

Examples:

dists( cpan => "/cpan");

Result:

Result:

Result:

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

Filter by author.

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

Defaults to ~/cpan .

Match query with exact module names.

Filename of index.

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

Search query.

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 (result) 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 distribution names. If you set detail to true, will return array of records.

List modules/packages.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

Filter by author.

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

Defaults to ~/cpan .

Filter by distribution.

Match query with exact module names.

Filename of index.

Select modules belonging to certain namespace.

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

Search query.

Sort the result.

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 (result) 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.

List namespaces.

This function is not exportable.

Arguments ('*' denotes required arguments):

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

Defaults to ~/cpan .

Match query with exact module names.

Filename of index.

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

Search query.

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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

Alias for modules .

List reverse dependencies.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

Filter certain author.

This can be used to select certain author(s).

Filter out certain author.

This can be used to filter out certain author(s). For example if you want to know whether a module is being used by another CPAN author instead of just herself.

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

Defaults to ~/cpan .

Filename of index.

Recurse for a number of levels (-1 means unlimited).

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 (result) 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 releases/tarballs.

The status field is the processing status of the file/release by lcpan. ok means file has been extracted and the meta files parsed, nofile means file is not found in mirror (possibly because the mirroring process excludes the file e.g. due to file size too large), nometa means file does not contain META.{yml,json}, unsupported means file archive format is not supported (e.g. rar), err means some other error in processing file.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

Filter by author.

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

Defaults to ~/cpan .

Match query with exact module names.

Filename of index.

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

Search query.

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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

Reset (empty) the database index.

This function is not exportable.

Arguments ('*' denotes required arguments):

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

Defaults to ~/cpan .

Filename of index.

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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

Statistics of your local CPAN mirror.

This function is not exportable.

Arguments ('*' denotes required arguments):

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

Defaults to ~/cpan .

Filename of index.

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 (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

Create/update local CPAN mirror.

This subcommand first create/update the mirror files by downloading from a remote CPAN mirror, then update the index.

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

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

Defaults to ~/cpan .

Exclude files from certain author(s).

Update the index even though there is no change in files.

Only include files from certain author(s).

Filename of index.

If set, skip downloading files larger than this.

Select CPAN mirror to download from.

Skip one or more files from being indexed.

Update the files.

Update the index.

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 (result) 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

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

To install App::lcpan, copy and paste the appropriate command in to your terminal.