- COPYRIGHT AND LICENSE
pmbin - List scripts that come with the same distribution of a Perl module
This document describes version 0.734 of pmbin (from Perl distribution App-PMUtils), released on 2020-06-12.
% pmbin Some::Module
Return full path instead of just names:
% pmbin -P Some::Module
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
* marks required options.
- --full-path, -P
Show full path instead of just filenames.
Can be specified multiple times.
Choose output format, e.g. json, text.
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
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:
Filter output through a pager.
View output using a viewer.
This script has shell tab completion capability with support for several shells.
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.
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).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-PMUtils.
Source repository is at https://github.com/perlancar/perl-App-PMUtils.
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.
This software is copyright (c) 2020, 2019, 2018, 2017, 2016, 2015, 2014 by firstname.lastname@example.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.