/ 
App-PMUtils-0.745
River stage one • 1 direct dependent • 1 total dependent
/ pmbin

NAME

pmbin - List scripts that come with the same distribution of a Perl module

VERSION

This document describes version 0.745 of pmbin (from Perl distribution App-PMUtils), released on 2024-08-30.

SYNOPSIS

Basic usage:

% pmbin Some::Module

Return full path instead of just names:

% pmbin -P Some::Module

DESCRIPTION

Does this happen often with you: you install a CPAN module:

% cpanm -n Finance::Bank::ID::BCA

The CPAN distribution is supposed to contain some CLI utilities, but it is not obvious what the name is. So you do:

% man Finance::Bank::ID::BCA

to find out, and even the module's POD doesn't give the name of the utility sometimes. You might even open your browser and go to MetaCPAN. Or download+extract+view the tarball just to find out.

Now there's a simpler alternative:

% pmbin Finance::Bank::ID::BCA
download-bca
parse-bca-statement

Show full path, process multiple modules at once:

% pmbin -P Finance/Bank/ID/BCA Finance::Bank::ID::Mandiri
/home/user/perl5/perlbrew/perls/perl-5.18.2/bin/download-bca
/home/user/perl5/perlbrew/perls/perl-5.18.2/bin/parse-bca-statement
/home/user/perl5/perlbrew/perls/perl-5.18.2/bin/download-mandiri
/home/user/perl5/perlbrew/perls/perl-5.18.2/bin/parse-mandiri-statement

You even get tab completion for free.

pmbin works by locating the .packlist file for the module (which contains the list of installed files) and filter only the /(bin,scripts?)/ ones.

OPTIONS

* marks required options.

Main options

--full-path, -P

Show full path instead of just filenames.

--module-json=s

See --module.

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

--module=s@

(No description)

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

Can be specified multiple times.

Output options

--format=s

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

Default value:

undef

Output can be displayed in multiple formats, and a suitable default format is chosen depending on the application and/or whether output destination is interactive terminal (i.e. whether output is piped). This option specifically chooses an output format.

--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

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

Filter output through a pager.

This option will pipe the output to a specified pager program. If pager program is not specified, a suitable default e.g. less is chosen.

--view-result

View output using a viewer.

This option will first save the output to a temporary file, then open a viewer program to view the temporary file. If a viewer program is not chosen, a suitable default, e.g. the browser, is chosen.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

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

bash

To activate bash completion for this script, put:

complete -C pmbin pmbin

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 pmbin 'p/*/`pmbin`/'

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.

HOMEPAGE

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

SOURCE

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

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2024, 2023, 2022, 2021, 2020, 2019, 2018, 2017, 2016, 2015, 2014 by perlancar <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.

BUGS

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

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.