—

              
#!perl
use 5.010;
use strict;
use warnings;
use App::PMUtils;
use Perinci::CmdLine::Any;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-08-30'; # DATE
our $DIST = 'App-PMUtils'; # DIST
our $VERSION = '0.745'; # VERSION
our %SPEC;
$SPEC{pmbin} = {
    v => 1.1,
    summary => 'List scripts that come with the same distribution '.
        'of a Perl 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.
<prog:pmbin> works by locating the `.packlist` file for the module (which contains
the list of installed files) and filter only the `/(bin,scripts?)/` ones.
_
    args => {
        module => $App::PMUtils::arg_module_multiple,
        full_path => {
            summary => 'Show full path instead of just filenames',
            schema => 'bool',
            cmdline_aliases => {P=>{}},
        },
    },
};
sub pmbin {
    require Dist::Util;
    my %args = @_;
    my $mods = $args{module};
    my $res = [];
    my $has_ok;
    my $has_nok;
    for my $mod (@{$mods}) {
        my $path = Dist::Util::packlist_for($mod);
        unless ($path && (-f $path)) {
            $has_nok++;
            next;
        }
        $has_ok++;
        open my $fh, "<", $path or do {
            warn "Can't open $path: $!\n";
            next;
        };
        while (<$fh>) {
            chomp;
            next unless m!/(bin|scripts?)/!;
            s!.+/!! unless $args{full_path};
            push @$res, $_;
        }
        close $fh;
    }
    if ($has_ok && $has_nok) {
        [207, "Some OK", $res];
    } elsif ($has_ok) {
        [200, "All OK", $res];
    } elsif ($has_nok) {
        [404, "Can't find .packlist for module(s)"];
    } else {
        [200, "No items"];
    }
}
Perinci::CmdLine::Any->new(
    url => '/main/pmbin',
    read_config => 0,
    read_env => 0,
)->run;
# ABSTRACT: List scripts that come with the same distribution of a Perl module
# PODNAME: pmbin
__END__
HideShow 242 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
pmbin - List scripts that come with the same distribution of a Perl module
=head1 VERSION
This document describes version 0.745 of pmbin (from Perl distribution App-PMUtils), released on 2024-08-30.
=head1 SYNOPSIS
Basic usage:
 % pmbin Some::Module
Return full path instead of just names:
 % pmbin -P Some::Module
=head1 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.
L<pmbin> works by locating the C<.packlist> file for the module (which contains
the list of installed files) and filter only the C</(bin,scripts?)/> ones.
=head1 OPTIONS
C<*> marks required options.
=head2 Main options
=over
=item B<--full-path>, B<-P>
Show full path instead of just filenames.
=item B<--module-json>=I<s>
See C<--module>.
Can also be specified as the 1st command-line argument and onwards.
=item B<--module>=I<s@>
(No description)
Can also be specified as the 1st command-line argument and onwards.
Can be specified multiple times.
=back
=head2 Output options
=over
=item B<--format>=I<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.
=item B<--json>
Set output format to json.
=item B<--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
C<--naked-res> so you just get:
 [1,2,3]
=item B<--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. C<less> is chosen.
=item B<--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.
=back
=head2 Other options
=over
=item B<--help>, B<-h>, B<-?>
Display help message and exit.
=item B<--version>, B<-v>
Display program's version and exit.
=back
=head1 COMPLETION
This script has shell tab completion capability with support for several
shells.
=head2 bash
To activate bash completion for this script, put:
 complete -C pmbin pmbin
in your bash startup (e.g. F<~/.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 L<cpanm-shcompgen>
which can activate shell completion for scripts immediately.
=head2 tcsh
To activate tcsh completion for this script, put:
 complete pmbin 'p/*/`pmbin`/'
in your tcsh startup (e.g. F<~/.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 L<shcompgen> (see above).
=head2 other shells
For fish and zsh, install L<shcompgen> as described above.
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-PMUtils>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-PMUtils>.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 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 L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<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.
=head1 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.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<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.
=cut