NAME

pdrutil-multi - Collection of utilities for perl dist repos

VERSION

This document describes version 0.122 of pdrutil-multi (from Perl distribution App-PDRUtils), released on 2021-05-25.

SYNOPSIS

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]]

DESCRIPTION

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:

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 = !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.)

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).
```
% 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
```

SUBCOMMANDS

add-prereq

Add a prereq.

dec-prereq-version-by

Decrease prereq version by a certain decrement.

dec-prereq-version-to

Decrease prereq version to a specified version.

inc-prereq-version-by

Increase prereq version by a certain increment.

inc-prereq-version-to

Increase prereq version to a specified version.

ls

List repos.

remove-prereq

Add a prereq.

set-prereq-version-to

Set prereq version to a specified version.

sort-prereqs

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.

Can detect one-spacing or two-spacing. Detects directives and comments.

OPTIONS

* marks required options.

Common options

--config-path=s, -c

Set path to configuration file.

--config-profile=s, -P

Set configuration profile to use.

--debug

Shortcut for --log-level=debug.

--depends-json=s

Only include repos that has prereq to specified module(s) (JSON-encoded).

See --depends.

--depends=s@

Only include repos that has prereq to specified module(s).

Can be specified multiple times.

--doesnt-depend-json=s

Exclude repos that has prereq to specified module(s) (JSON-encoded).

See --doesnt-depend.

--doesnt-depend=s@

Exclude repos that has prereq to specified module(s).

Can be specified multiple times.

--exclude-dist-pattern=s@

Exclude repos which match specified pattern(s).

Can be specified multiple times.

--exclude-dist-patterns-json=s

Exclude repos which match specified pattern(s) (JSON-encoded).

See --exclude-dist-pattern.

--exclude-dist=s@

Exclude repos which have specified name(s).

Can be specified multiple times.

--exclude-dists-json=s

Exclude repos which have specified name(s) (JSON-encoded).

See --exclude-dist.

--format=s

Choose output format, e.g. json, text.

Default value:

undef

--has-tag=s@

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`.

Can be specified multiple times.

--has-tags-json=s

Only include repos which have specified tag(s) (JSON-encoded).

See --has-tag.

--help, -h, -?

Display help message and exit.

--include-dist-pattern=s@

Only include repos which match specified pattern(s).

Can be specified multiple times.

--include-dist-patterns-json=s

Only include repos which match specified pattern(s) (JSON-encoded).

See --include-dist-pattern.

--include-dist=s@

Only include repos which have specified name(s).

Can be specified multiple times.

--include-dists-json=s

Only include repos which have specified name(s) (JSON-encoded).

See --include-dist.

--json

Set output format to json.

--lacks-tag=s@

Exclude repos which have specified tag(s).

A repo can be tagged by tag `X` if it has a top-level file named `.tag-X`.

Can be specified multiple times.

--lacks-tags-json=s

Exclude repos which have specified tag(s) (JSON-encoded).

See --lacks-tag.

--log-level=s

Set log level.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

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]

--no-config, -C

Do not use any configuration file.

--no-env

Do not read environment for default options.

--page-result

Filter output through a pager.

--quiet

Shortcut for --log-level=error.

--repo=s@

Can be specified multiple times.

--repos-json=s

See --repo.

--subcommands

List available subcommands.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

--version, -v

Display program's version and exit.

--view-result

View output using a viewer.

Options for subcommand add-prereq

--module-version=s

Default value:

Can also be specified as the 2nd command-line argument.

--module=s*

Can also be specified as the 1st command-line argument.

--phase=s

Select prereq phase.

Default value:

"runtime"

--rel=s

Select prereq relationship.

Default value:

"requires"

Options for subcommand dec-prereq-version-by

--by=s*: Can also be specified as the 2nd command-line argument.
--module=s*: Can also be specified as the 1st command-line argument.

Options for subcommand dec-prereq-version-to

--module-version=s*: Can also be specified as the 2nd command-line argument.
--module=s*: Can also be specified as the 1st command-line argument.

Options for subcommand inc-prereq-version-by

--by=s*: Can also be specified as the 2nd command-line argument.
--module=s*: Can also be specified as the 1st command-line argument.

Options for subcommand inc-prereq-version-to

--module-version=s*: Can also be specified as the 2nd command-line argument.
--module=s*: Can also be specified as the 1st command-line argument.

Options for subcommand ls

--detail, -l
--dist, -d: Show dist names instead of repo dirs.

Options for subcommand remove-prereq

--module=s*: Can also be specified as the 1st command-line argument.

Options for subcommand set-prereq-version-to

--module-version=s*: Can also be specified as the 2nd command-line argument.
--module=s*: Can also be specified as the 1st command-line argument.

Options for subcommand sort-prereqs

--spacing=s: Set spacing explicitly.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

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.

tcsh

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

other shells

For fish and zsh, install shcompgen as described above.

CONFIGURATION FILE

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.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

To put configuration for a certain subcommand only, use a section name like [subcommand=NAME] or [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.

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.

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.

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:

[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.

List of available configuration parameters:

Common for all subcommands

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)

Configuration for subcommand add-prereq

module (see --module)
module_version (see --module-version)
phase (see --phase)
rel (see --rel)

Configuration for subcommand dec-prereq-version-by

by (see --by)
module (see --module)

Configuration for subcommand dec-prereq-version-to

module (see --module)
module_version (see --module-version)

Configuration for subcommand inc-prereq-version-by

by (see --by)
module (see --module)

Configuration for subcommand inc-prereq-version-to

module (see --module)
module_version (see --module-version)

Configuration for subcommand ls

detail (see --detail)
dist (see --dist)

Configuration for subcommand remove-prereq

module (see --module)

Configuration for subcommand set-prereq-version-to

module (see --module)
module_version (see --module-version)

Configuration for subcommand sort-prereqs

spacing (see --spacing)

ENVIRONMENT

PDRUTIL_MULTI_OPT => str

Specify additional command-line options.

FILES

~/.config/pdrutil-multi.conf

~/pdrutil-multi.conf

/etc/pdrutil-multi.conf

HOMEPAGE

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

SOURCE

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

BUGS

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

SUBCOMMANDS

add-prereq

dec-prereq-version-by

dec-prereq-version-to

inc-prereq-version-by

inc-prereq-version-to

ls

remove-prereq

set-prereq-version-to

sort-prereqs

OPTIONS

Common options

Options for subcommand add-prereq

Options for subcommand dec-prereq-version-by

Options for subcommand dec-prereq-version-to

Options for subcommand inc-prereq-version-by

Options for subcommand inc-prereq-version-to

Options for subcommand ls

Options for subcommand remove-prereq

Options for subcommand set-prereq-version-to

Options for subcommand sort-prereqs

COMPLETION

bash

tcsh

other shells

CONFIGURATION FILE

Common for all subcommands

Configuration for subcommand add-prereq

Configuration for subcommand dec-prereq-version-by

Configuration for subcommand dec-prereq-version-to

Configuration for subcommand inc-prereq-version-by

Configuration for subcommand inc-prereq-version-to

Configuration for subcommand ls

Configuration for subcommand remove-prereq

Configuration for subcommand set-prereq-version-to

Configuration for subcommand sort-prereqs

ENVIRONMENT

PDRUTIL_MULTI_OPT => str

FILES

HOMEPAGE

SOURCE

BUGS

SEE ALSO

AUTHOR

COPYRIGHT AND LICENSE

Module Install Instructions