App::lcpan::Cmd::author_deps - List dependencies for all of the dists of an author
This document describes version 1.061 of App::lcpan::Cmd::author_deps (from Perl distribution App-lcpan), released on 2020-06-11.
Usage:
handle_cmd(%args) -> [status, msg, payload, meta]
List dependencies for all of the dists of an author.
For a CPAN author, this subcommand is a shortcut for doing:
% lcpan deps Your-Dist
for all of your distributions. It shows just how many modules are you currently using in one of your distros on CPAN.
To show how many modules from other authors you are depending:
% lcpan author-deps YOURCPANID --module-author-isnt YOURCPANID
To show how many of your own modules you are depending in your own distros:
% lcpan author-deps YOURCPANID --module-author-is YOURCPANID
To find whether there are any prerequisites that you mention in your distributions that are currently broken (not indexed on CPAN):
% lcpan author-deps YOURCPANID --broken --dont-uniquify
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
cpan => dirname
Location of your local CPAN mirror, e.g. /path/to/cpan.
Defaults to ~/cpan.
~/cpan
dont_uniquify => bool
Allow showing multiple modules for different dists.
flatten => bool
Instead of showing tree-like information, flatten it.
When recursing, the default is to show the final result in a tree-like table, i.e. indented according to levels, e.g.:
% lcpan deps -R MyModule | module | author | version | |-------------------|---------|---------| | Foo | AUTHOR1 | 0.01 | | Bar | AUTHOR2 | 0.23 | | Baz | AUTHOR3 | 1.15 | | Qux | AUTHOR2 | 0 |
To be brief, if Qux happens to also depends on Bar, it will not be shown in the result. Thus we don't know the actual Bar version that is needed by the dependency tree of MyModule. For example, if Qux happens to depends on Bar version 0.45 then MyModule indirectly requires Bar 0.45.
Qux
Bar
MyModule
To list all the direct and indirect dependencies on a single flat list, with versions already resolved to the largest version required, use the flatten option:
flatten
% lcpan deps -R --flatten MyModule | module | author | version | |-------------------|---------|---------| | Foo | AUTHOR1 | 0.01 | | Bar | AUTHOR2 | 0.45 | | Baz | AUTHOR3 | 1.15 | | Qux | AUTHOR2 | 0 |
Note that Bar's required version is already 0.45 in the above example.
include_core => bool (default: 1)
Include core modules.
include_indexed => bool (default: 1)
Include modules that are indexed (listed in 02packages.details.txt.gz).
include_noncore => bool (default: 1)
Include non-core modules.
include_unindexed => bool (default: 1)
Include modules that are not indexed (not listed in 02packages.details.txt.gz).
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.
index_name
index.db
cpan
./index.db
/home/ujang/lcpan.db
level => int (default: 1)
Recurse for a number of levels (-1 means unlimited).
module_authors => array[str]
Only list depended modules published by specified author(s).
module_authors_arent => array[str]
Do not list depended modules published by specified author(s).
perl_version => str (default: "v5.30.2")
Set base Perl version for determining core modules.
phase => str (default: "runtime")
rel => str (default: "requires")
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.
with_xs_or_pp => bool
Check each dependency as XS/PP.
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)
Please visit the project's homepage at https://metacpan.org/release/App-lcpan.
Source repository is at https://github.com/perlancar/perl-App-lcpan.
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.
perlancar <perlancar@cpan.org>
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.
To install App::lcpan, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::lcpan
CPAN shell
perl -MCPAN -e shell install App::lcpan
For more information on module installation, please visit the detailed CPAN module installation guide.