NAME

check-module-version - Check module (e.g. check latest version) with CPAN (or equivalent repo)

VERSION

This document describes version 0.08 of main (from Perl distribution Module-CheckVersion), released on 2017-06-09.

SYNOPSIS

Usage:

 % check-module-version [options] <module>

DESCRIPTION

Designed to be more general and able to provide more information in the future in addition to mere checking of latest version, but checking latest version is currently the only implemented feature.

Can handle non-CPAN modules, as long as you put the appropriate $AUTHORITY in your modules and create the "Module::CheckVersion::<scheme>" to handle your authority scheme.

OPTIONS

"*" marks required options.

Main options

--default-authority-scheme=s

Default value:

 "cpan"

If a module does not set `$AUTHORITY` (which contains string like `<scheme>:<extra>` like `cpan:PERLANCAR`), the default authority scheme will be determined from this setting. The module `Module::CheckVersion::<scheme>` module is used to implement actual checking.

Can also be set to undef, in which case when module's `$AUTHORITY` is not available, will return 412 status.

--module=s*

This routine will try to load the module, and retrieve its `$VERSION`. If loading fails will assume module's installed version is undef.

--no-check-latest-version

Configuration options

--config-path=filename: Set path to configuration file.
Can be specified multiple times.
--config-profile=s: Set configuration profile to use.
--no-config: Do not use any configuration file.

Environment options

--no-env: Do not read environment for default options.

Output options

--format=s

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

Default value:

 undef

--json

Set output format to json.

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

Other options

--help, -h, -?: Display help message and exit.
--version, -v: Display program's version and exit.

COMPLETION

The script comes with a companion shell completer script (_check-module-version) for this script.

bash

To activate bash completion for this script, put:

 complete -C _check-module-version check-module-version

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 shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immediately have tab completion.

tcsh

To activate tcsh completion for this script, put:

 complete check-module-version 'p/*/`check-module-version`/'

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/check-module-version.conf, ~/check-module-version.conf, or /etc/check-module-version.conf.

All found files will be read and merged.

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

You can put multiple profiles in a single file by using section names like "[profile=SOMENAME]" or "[SOMESECTION 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.

Finally, you can 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 has value equals something: "[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 something: "[env=HOSTNAME!=blink ...]" or "[SOMESECTION env=HOSTNAME!=blink ...]". If you only want a section to be read when an environment variable contains something: "[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.

List of available configuration parameters:

 check_latest_version (see --no-check-latest-version)
 default_authority_scheme (see --default-authority-scheme)
 format (see --format)
 module (see --module)
 naked_res (see --naked-res)

ENVIRONMENT

CHECK_MODULE_VERSION_OPT => str

Specify additional command-line options.

FILES

~/.config/check-module-version.conf

~/check-module-version.conf

/etc/check-module-version.conf

HOMEPAGE

Please visit the project's homepage at <https://metacpan.org/release/Module-CheckVersion>.

SOURCE

Source repository is at <https://github.com/perlancar/perl-Module-CheckVersion>.

BUGS

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

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.