pdrutil-multi - Collection of utilities for perl dist repos
This document describes version 0.122 of pdrutil-multi (from Perl distribution App-PDRUtils), released on 2021-05-25.
Usage:
% pdrutil-multi add-prereq [--config-path=path | -c] [--config-profile=profile | -P] [--debug] [--depends-json=s] [--depends=s+] [--doesnt-depend-json=s] [--doesnt-depend=s+] [--exclude-dist-pattern=s+] [--exclude-dist-patterns-json=s] [--exclude-dist=s+] [--exclude-dists-json=s] [--format=name] [--has-tag=s+] [--has-tags-json=s] [--include-dist-pattern=s+] [--include-dist-patterns-json=s] [--include-dist=s+] [--include-dists-json=s] [--json] [--lacks-tag=s+] [--lacks-tags-json=s] [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env] [--page-result[=program]] [--phase=s] [--quiet] [--rel=s] [--repo=s+] [--repos-json=s] [--trace] [--verbose] [--view-result[=program]] <module> [module_version] % pdrutil-multi dec-prereq-version-by [--config-path=path | -c] [--config-profile=profile | -P] [--debug] [--depends-json=s] [--depends=s+] [--doesnt-depend-json=s] [--doesnt-depend=s+] [--exclude-dist-pattern=s+] [--exclude-dist-patterns-json=s] [--exclude-dist=s+] [--exclude-dists-json=s] [--format=name] [--has-tag=s+] [--has-tags-json=s] [--include-dist-pattern=s+] [--include-dist-patterns-json=s] [--include-dist=s+] [--include-dists-json=s] [--json] [--lacks-tag=s+] [--lacks-tags-json=s] [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env] [--page-result[=program]] [--quiet] [--repo=s+] [--repos-json=s] [--trace] [--verbose] [--view-result[=program]] <module> <by> % pdrutil-multi dec-prereq-version-to [--config-path=path | -c] [--config-profile=profile | -P] [--debug] [--depends-json=s] [--depends=s+] [--doesnt-depend-json=s] [--doesnt-depend=s+] [--exclude-dist-pattern=s+] [--exclude-dist-patterns-json=s] [--exclude-dist=s+] [--exclude-dists-json=s] [--format=name] [--has-tag=s+] [--has-tags-json=s] [--include-dist-pattern=s+] [--include-dist-patterns-json=s] [--include-dist=s+] [--include-dists-json=s] [--json] [--lacks-tag=s+] [--lacks-tags-json=s] [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env] [--page-result[=program]] [--quiet] [--repo=s+] [--repos-json=s] [--trace] [--verbose] [--view-result[=program]] <module> <module_version> % pdrutil-multi inc-prereq-version-by [--config-path=path | -c] [--config-profile=profile | -P] [--debug] [--depends-json=s] [--depends=s+] [--doesnt-depend-json=s] [--doesnt-depend=s+] [--exclude-dist-pattern=s+] [--exclude-dist-patterns-json=s] [--exclude-dist=s+] [--exclude-dists-json=s] [--format=name] [--has-tag=s+] [--has-tags-json=s] [--include-dist-pattern=s+] [--include-dist-patterns-json=s] [--include-dist=s+] [--include-dists-json=s] [--json] [--lacks-tag=s+] [--lacks-tags-json=s] [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env] [--page-result[=program]] [--quiet] [--repo=s+] [--repos-json=s] [--trace] [--verbose] [--view-result[=program]] <module> <by> % pdrutil-multi inc-prereq-version-to [--config-path=path | -c] [--config-profile=profile | -P] [--debug] [--depends-json=s] [--depends=s+] [--doesnt-depend-json=s] [--doesnt-depend=s+] [--exclude-dist-pattern=s+] [--exclude-dist-patterns-json=s] [--exclude-dist=s+] [--exclude-dists-json=s] [--format=name] [--has-tag=s+] [--has-tags-json=s] [--include-dist-pattern=s+] [--include-dist-patterns-json=s] [--include-dist=s+] [--include-dists-json=s] [--json] [--lacks-tag=s+] [--lacks-tags-json=s] [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env] [--page-result[=program]] [--quiet] [--repo=s+] [--repos-json=s] [--trace] [--verbose] [--view-result[=program]] <module> <module_version> % pdrutil-multi ls [--config-path=path | -c] [--config-profile=profile | -P] [-d] [--debug] [--depends-json=s] [--depends=s+] [--detail] [--dist] [--doesnt-depend-json=s] [--doesnt-depend=s+] [--exclude-dist-pattern=s+] [--exclude-dist-patterns-json=s] [--exclude-dist=s+] [--exclude-dists-json=s] [--format=name] [--has-tag=s+] [--has-tags-json=s] [--include-dist-pattern=s+] [--include-dist-patterns-json=s] [--include-dist=s+] [--include-dists-json=s] [--json] [-l] [--lacks-tag=s+] [--lacks-tags-json=s] [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-detail] [--no-dist] [--no-env] [--nodetail] [--nodist] [--page-result[=program]] [--quiet] [--repo=s+] [--repos-json=s] [--trace] [--verbose] [--view-result[=program]] % pdrutil-multi remove-prereq [--config-path=path | -c] [--config-profile=profile | -P] [--debug] [--depends-json=s] [--depends=s+] [--doesnt-depend-json=s] [--doesnt-depend=s+] [--exclude-dist-pattern=s+] [--exclude-dist-patterns-json=s] [--exclude-dist=s+] [--exclude-dists-json=s] [--format=name] [--has-tag=s+] [--has-tags-json=s] [--include-dist-pattern=s+] [--include-dist-patterns-json=s] [--include-dist=s+] [--include-dists-json=s] [--json] [--lacks-tag=s+] [--lacks-tags-json=s] [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env] [--page-result[=program]] [--quiet] [--repo=s+] [--repos-json=s] [--trace] [--verbose] [--view-result[=program]] <module> % pdrutil-multi set-prereq-version-to [--config-path=path | -c] [--config-profile=profile | -P] [--debug] [--depends-json=s] [--depends=s+] [--doesnt-depend-json=s] [--doesnt-depend=s+] [--exclude-dist-pattern=s+] [--exclude-dist-patterns-json=s] [--exclude-dist=s+] [--exclude-dists-json=s] [--format=name] [--has-tag=s+] [--has-tags-json=s] [--include-dist-pattern=s+] [--include-dist-patterns-json=s] [--include-dist=s+] [--include-dists-json=s] [--json] [--lacks-tag=s+] [--lacks-tags-json=s] [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env] [--page-result[=program]] [--quiet] [--repo=s+] [--repos-json=s] [--trace] [--verbose] [--view-result[=program]] <module> <module_version> % pdrutil-multi sort-prereqs [--config-path=path | -c] [--config-profile=profile | -P] [--debug] [--depends-json=s] [--depends=s+] [--doesnt-depend-json=s] [--doesnt-depend=s+] [--exclude-dist-pattern=s+] [--exclude-dist-patterns-json=s] [--exclude-dist=s+] [--exclude-dists-json=s] [--format=name] [--has-tag=s+] [--has-tags-json=s] [--include-dist-pattern=s+] [--include-dist-patterns-json=s] [--include-dist=s+] [--include-dists-json=s] [--json] [--lacks-tag=s+] [--lacks-tags-json=s] [--log-level=level] [--(no)naked-res] [--no-config | -C] [--no-env] [--page-result[=program]] [--quiet] [--repo=s+] [--repos-json=s] [--spacing=s] [--trace] [--verbose] [--view-result[=program]]
EARLY RELEASE. SOME THINGS ARE NOT YET IMPLEMENTED.
This utility operates multiple Perl distribution repositories. To use this utility, first create a configuration ~/pdrutil-multi.conf containing at the very least something like:
~/pdrutil-multi.conf
repos = !paths ~/repos/perl-*
You can change the ~/repos/perl-* part to a wildcard of where you put your perl dist repos. Another example where you specify multiple wildcard patterns:
~/repos/perl-*
repos = !paths ~/repos/perl-* ~/repos-[12]*/perl-* ~/repos-private/perl-*
Or, if you prefer to specify the repos individually:
repos = /home/budi/Foo-Bar repos = /home/budi/Foo-Baz repos = /home/budi/Qux repos = !path ~/perl-Module-Zap
(Note that if you want ~ to be expanded into your home directory, like in a Unix shell, you need to put !path encoding as the prefix for the value. See IOD for more details on the configuration format.)
~
!path
A few things that you can do:
List repositories based on various criteria
List the repositories (directory names):
% pdrutil-multi ls
List the directory names as well as other details of the repositories:
% pdrutil-multi ls -l
List repositories that have unclean git status (needs to be committed, etc):
% pdrutil-multi ls --no-git-clean
List repositories that specify prereq to a certain module:
% pdrutil-multi ls --depends Foo::Bar % pdrutil-multi ls --depends 'Foo::Bar >= 0.12' % pdrutil-multi ls --depends 'Foo::Bar = 0.12' % pdrutil-multi ls --depends 'Foo::Bar < 0.12'
List repositories that depend on certain prereq in a certain phase/relationship only:
% pdrutil-multi ls --depends 'Test::More < 0.98' --phase test
List distributions that does not depend on a certain module:
% pdrutil-multi ls --doesnt-depend Baz
Add prereq
Add a prereq to Foo::Bar (by default version is 0 and if there is already an existing prereq to Foo::Bar, will do nothing).
Foo::Bar
0
% pdrutil-multi add-prereq Foo::Bar
Set version, and replace existing prereq line:
% pdrutil-multi add-prereq --replace Foo::Bar 1.23
Remove prereq
% pdrutil-multi remove-prereq Foo::Bar
Modify prereq: set/increase/decrease version
For example, you want to increase the minimum prereq version for all your distributions, e.g. Bencher to 0.30:
% pdrutil-multi inc-prereq-version-to Bencher 0.30
All distributions which do not list Bencher as a prereq in their dist.ini, or distributions which already list Bencher version 0.30 or later, won't be modified.
Some other examples:
% pdrutil-multi dec-prereq-version-to Some::Module 1.2 % pdrutil-multi inc-prereq-version-by Some::Module 0.01 % pdrutil-multi dec-prereq-version-by Some::Module 0.01 % pdrutil-multi set-prereq-version-to Some::Module 1.2
Add a prereq.
Decrease prereq version by a certain decrement.
Decrease prereq version to a specified version.
Increase prereq version by a certain increment.
Increase prereq version to a specified version.
List repos.
Set prereq version to a specified version.
Sort lines in `[Prereqs/*]` sections.
This command can sort [Prereqs/*] sections in your dist.ini according to this rule (TODO: allow customized rule): perl comes first, then pragmas sorted ascibetically and case-insensitively (e.g. strict, utf8, warnings), then other modules sorted ascibetically and case-insensitively.
[Prereqs/*]
dist.ini
perl
strict
utf8
warnings
Can detect one-spacing or two-spacing. Detects directives and comments.
* marks required options.
*
Set path to configuration file.
Set configuration profile to use.
Shortcut for --log-level=debug.
Only include repos that has prereq to specified module(s) (JSON-encoded).
See --depends.
--depends
Only include repos that has prereq to specified module(s).
Can be specified multiple times.
Exclude repos that has prereq to specified module(s) (JSON-encoded).
See --doesnt-depend.
--doesnt-depend
Exclude repos that has prereq to specified module(s).
Exclude repos which match specified pattern(s).
Exclude repos which match specified pattern(s) (JSON-encoded).
See --exclude-dist-pattern.
--exclude-dist-pattern
Exclude repos which have specified name(s).
Exclude repos which have specified name(s) (JSON-encoded).
See --exclude-dist.
--exclude-dist
Choose output format, e.g. json, text.
Default value:
undef
Only include repos which have specified tag(s).
A repo can be tagged by tag `X` if it has a top-level file named `.tag-X`.
Only include repos which have specified tag(s) (JSON-encoded).
See --has-tag.
--has-tag
Display help message and exit.
Only include repos which match specified pattern(s).
Only include repos which match specified pattern(s) (JSON-encoded).
See --include-dist-pattern.
--include-dist-pattern
Only include repos which have specified name(s).
Only include repos which have specified name(s) (JSON-encoded).
See --include-dist.
--include-dist
Set output format to json.
Exclude repos which have specified tag(s).
Exclude repos which have specified tag(s) (JSON-encoded).
See --lacks-tag.
--lacks-tag
Set log level.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
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:
[1,2,3]
Do not use any configuration file.
Do not read environment for default options.
Filter output through a pager.
Shortcut for --log-level=error.
See --repo.
--repo
List available subcommands.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Display program's version and exit.
View output using a viewer.
Can also be specified as the 2nd command-line argument.
Can also be specified as the 1st command-line argument.
Select prereq phase.
"runtime"
Select prereq relationship.
"requires"
Show dist names instead of repo dirs.
Set spacing explicitly.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C pdrutil-multi pdrutil-multi
in your bash startup (e.g. ~/.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 cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete pdrutil-multi 'p/*/`pdrutil-multi`/'
in your tcsh startup (e.g. ~/.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 shcompgen (see above).
For fish and zsh, install shcompgen as described above.
This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.
By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/pdrutil-multi.conf, ~/pdrutil-multi.conf, or /etc/pdrutil-multi.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
--no-config
To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [SOMESECTION subcommand=NAME].
[subcommand=NAME]
[SOMESECTION subcommand=NAME]
You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME] or [subcommand=SUBCOMMAND_NAME profile=SOMENAME] or [SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
[subcommand=SUBCOMMAND_NAME profile=SOMENAME]
[SOMESECTION subcommand=SUBCOMMAND_NAME profile=SOMENAME]
--config-profile SOMENAME
You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
You can also filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable equals some string: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [env=HOSTNAME!*=server ...] or [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.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
[env=HOSTNAME!*=server ...]
[SOMESECTION env=HOSTNAME!*=server ...]
To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:
-plugins
-plugins=DumpArgs
-plugins=DumpArgs@before_validate_args
[plugin=NAME ...]
[plugin=DumpArgs] -event=before_validate_args -prio=99 [plugin=Foo] -event=after_validate_args arg1=val1 arg2=val2
which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.
-plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2
List of available configuration parameters:
depends (see --depends) doesnt_depend (see --doesnt-depend) exclude_dist_patterns (see --exclude-dist-pattern) exclude_dists (see --exclude-dist) format (see --format) has_tags (see --has-tag) include_dist_patterns (see --include-dist-pattern) include_dists (see --include-dist) lacks_tags (see --lacks-tag) log_level (see --log-level) naked_res (see --naked-res) repos (see --repo)
module (see --module) module_version (see --module-version) phase (see --phase) rel (see --rel)
by (see --by) module (see --module)
module (see --module) module_version (see --module-version)
detail (see --detail) dist (see --dist)
module (see --module)
spacing (see --spacing)
Specify additional command-line options.
~/.config/pdrutil-multi.conf
/etc/pdrutil-multi.conf
Please visit the project's homepage at https://metacpan.org/release/App-PDRUtils.
Source repository is at https://github.com/perlancar/perl-App-PDRUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-PDRUtils
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.
pdrutil which operates on a single Perl distribution repository at a time.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2021, 2019, 2018, 2017, 2016 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::PDRUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::PDRUtils
CPAN shell
perl -MCPAN -e shell install App::PDRUtils
For more information on module installation, please visit the detailed CPAN module installation guide.