#!perl use 5.010; use strict; use warnings; use App::ProgUtils; use Perinci::CmdLine::Any; our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY our $DATE = '2022-08-09'; # DATE our $DIST = 'App-ProgUtils'; # DIST our $VERSION = '0.203'; # VERSION our %SPEC; $SPEC{proglist} = { v => 1.1, summary => 'List programs matching query', args => { query => { schema => 're*', req => 0, pos => 0, }, }, examples => [ { summary => 'List all programs that have "font" in their name', argv => [qw/font/], test => 0, 'x.doc.show_result'=>0, }, { summary => 'List all programs', argv => [], test => 0, 'x.doc.show_result'=>0, }, ], links => [ {url=>'prog:list-all-programs-in-path'}, ], }; sub proglist { require File::Which; my %args = @_; my $re = $args{query} || qr//; my @res; for my $dir (split /:/, $ENV{PATH}) { opendir my $dh, $dir or next; for my $e (readdir $dh) { next if $e eq '.' || $e eq '..'; next if -d $e; next unless $e =~ $re; push @res, $e; } } [200, "OK", \@res]; } Perinci::CmdLine::Any->new( url => '/main/proglist', read_config => 0, read_env => 0, )->run; # ABSTRACT: List programs matching query # PODNAME: proglist __END__ =pod =encoding UTF-8 =head1 NAME proglist - List programs matching query =head1 VERSION This document describes version 0.203 of proglist (from Perl distribution App-ProgUtils), released on 2022-08-09. =head1 SYNOPSIS % B<proglist> [B<--format>=I<name>|B<--json>] [B<--(no)naked-res>] [B<--page-result>[=I<program>]|B<--view-result>[=I<program>]] -- [I<query>] See examples in the L</EXAMPLES> section. =head1 OPTIONS C<*> marks required options. =head2 Main options =over =item B<--query>=I<s> Can also be specified as the 1st command-line argument. =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 proglist proglist 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 proglist 'p/*/`proglist`/' 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 EXAMPLES =head2 List all programs that have "font" in their name % proglist font =head2 List all programs % proglist =head1 HOMEPAGE Please visit the project's homepage at L<https://metacpan.org/release/App-ProgUtils>. =head1 SOURCE Source repository is at L<https://github.com/perlancar/perl-App-ProgUtils>. =head1 SEE ALSO L<list-all-programs-in-path>. =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>, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. 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) 2022, 2020, 2019, 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-ProgUtils> 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