—

              
#!perl
# Note: This script is a CLI for Riap function /App/abgrep/abgrep
# and generated automatically using Perinci::CmdLine::Gen version 0.502
use 5.010001;
use strict;
use warnings;
use Log::ger;
use Perinci::CmdLine::Any;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2024-01-25'; # DATE
our $DIST = 'App-abgrep'; # DIST
our $VERSION = '0.010'; # VERSION
my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/abgrep/abgrep",
    program_name => "abgrep",
    log => 1,
    read_config => 0,
    read_env => 0,
);
$cmdline->{common_opts}{version}{getopt} = "version|V";
$cmdline->run;
# ABSTRACT: Print lines matching a pattern
# PODNAME: abgrep
__END__
HideShow 365 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
abgrep - Print lines matching a pattern
=head1 VERSION
This document describes version 0.010 of abgrep (from Perl distribution App-abgrep), released on 2024-01-25.
=head1 SYNOPSIS
B<abgrep> B<L<--help|/"--help, -h, -?">> (or B<L<-h|/"--help, -h, -?">>, B<L<-?|/"--help, -h, -?">>)
B<abgrep> B<L<--version|/"--version, -v">> (or B<L<-v|/"--version, -v">>)
B<abgrep> [B<L<--all|/"--all">>] [B<L<--color|/"--color=s">>=I<str>] [B<L<--count|/"--count, -c">>|B<L<-c|/"--count, -c">>] [B<L<--dash-prefix-inverts|/"--dash-prefix-inverts">>|B<L<--no-dash-prefix-inverts|/"--dash-prefix-inverts">>|B<L<--nodash-prefix-inverts|/"--dash-prefix-inverts">>] [B<L<--debug|/"--debug">>|B<L<--log-level|/"--log-level=s">>=I<level>|B<L<--quiet|/"--quiet">>|B<L<--trace|/"--trace">>|B<L<--verbose|/"--verbose">>] [B<L<--dereference-recursive|/"--dereference-recursive, -R">>|B<L<-R|/"--dereference-recursive, -R">>] [(B<L<--file|/"--files-json=s">>=I<L<filename|Sah::Schema::filename>>)+|B<L<--files-json|/"--files-json=s">>=I<json>] [B<L<--files-with-matches|/"--files-with-matches, -l">>|B<L<-l|/"--files-with-matches, -l">>] [B<L<--files-without-match|/"--files-without-match, -L">>|B<L<-L|/"--files-without-match, -L">>] [B<L<--format|/"--format=s">>=I<name>|B<L<--json|/"--json">>] [B<L<--ignore-case|/"--ignore-case, -i">>|B<L<-i|/"--ignore-case, -i">>|B<L<--no-ignore-case|/"--ignore-case, -i">>|B<L<--noignore-case|/"--ignore-case, -i">>] [B<L<--invert-match|/"--invert-match, -v">>|B<L<-v|/"--invert-match, -v">>|B<L<--no-invert-match|/"--invert-match, -v">>|B<L<--noinvert-match|/"--invert-match, -v">>] [B<L<--line-number|/"--line-number, -n">>|B<L<-n|/"--line-number, -n">>] [B<L<--(no)naked-res|/"--naked-res">>] [B<L<--page-result|/"--page-result">>[=I<program>]|B<L<--view-result|/"--view-result">>[=I<program>]] [B<L<--quiet-arg|/"--quiet-arg, --silent, -q">>|B<L<-q|/"--quiet-arg, --silent, -q">>|B<L<--silent|/"--quiet-arg, --silent, -q">>] [B<L<--recursive|/"--recursive, -r">>|B<L<-r|/"--recursive, -r">>] [(B<L<--regexp|/"--regexps-json=s">>=I<str>)+|B<L<--regexps-json|/"--regexps-json=s">>=I<json>|(B<L<-e|/"--regexps-json=s">>=I<str>)+] -- [I<L<pattern|/"--pattern=s">>] [I<L<file|/"--files-json=s">>] ...
See examples in the L</EXAMPLES> section.
=head1 DESCRIPTION
This is a grep-like utility that is based on L<AppBase::Grep>, mainly for
demoing and testing the module. The unique features include multiple patterns
and C<--dash-prefix-inverts>.
=head1 OPTIONS
C<*> marks required options.
=head2 Main options
=over
=item B<--dereference-recursive>, B<-R>
Read all files under each directory, recursively, following all symbolic links, unlike -r.
=item B<--file>=I<s@>
(No description)
Can also be specified as the 2nd command-line argument and onwards.
Can be specified multiple times.
=item B<--files-json>=I<s>
See C<--file>.
Can also be specified as the 2nd command-line argument and onwards.
=item B<--pattern>=I<s>
Specify *string* to search for.
Can also be specified as the 1st command-line argument.
=item B<--recursive>, B<-r>
Read all files under each directory, recursively, following symbolic links only if they are on the command line.
=item B<--regexp>=I<s@>
Specify additional *regexp pattern* to search for.
Can be specified multiple times.
=item B<--regexps-json>=I<s>
Specify additional *regexp pattern* to search for (JSON-encoded).
See C<--regexp>.
=item B<-e>=I<s@>
Alias for --regexp.
See C<--regexp>.
Can be specified multiple times.
=back
=head2 General output control options
=over
=item B<--color>=I<s>
Specify when to show color (never, always, or auto/when interactive).
Default value:
 "auto"
Valid values:
 ["never","always","auto"]
=item B<--count>, B<-c>
Supress normal output; instead return a count of matching lines.
=item B<--files-with-matches>, B<-l>
Supress normal output; instead return filenames with matching lines; scanning for each file will stop on the first match.
=item B<--files-without-match>, B<-L>
Supress normal output; instead return filenames without matching lines.
=item B<--quiet-arg>, B<--silent>, B<-q>
Do not print matches, only return appropriate exit code.
=back
=head2 Logging options
=over
=item B<--debug>
Shortcut for --log-level=debug.
=item B<--log-level>=I<s>
Set log level.
By default, these log levels are available (in order of increasing level of
importance, from least important to most): C<trace>, C<debug>, C<info>,
C<warn>/C<warning>, C<error>, C<fatal>. By default, the level is usually set to
C<warn>, which means that log statements with level C<info> and less important
levels will not be shown. To increase verbosity, choose C<info>, C<debug>, or
C<trace>.
For more details on log level and logging, as well as how new logging levels can
be defined or existing ones modified, see L<Log::ger>.
=item B<--quiet>
Shortcut for --log-level=error.
=item B<--trace>
Shortcut for --log-level=trace.
=item B<--verbose>
Shortcut for --log-level=info.
=back
=head2 Matching control options
=over
=item B<--all>
Require all patterns to match, instead of just one.
=item B<--dash-prefix-inverts>
When given pattern that starts with dash "-FOO", make it to mean "^(?!.*FOO)".
This is a convenient way to search for lines that do not match a pattern.
Instead of using C<-v> to invert the meaning of all patterns, this option allows
you to invert individual pattern using the dash prefix, which is also used by
Google search and a few other search engines.
=item B<--ignore-case>, B<-i>
If set to true, will search case-insensitively.
=item B<--invert-match>, B<-v>
Invert the sense of matching.
=back
=head2 Output line prefix control options
=over
=item B<--line-number>, B<-n>
Show line number along with matches.
=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 abgrep abgrep
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 abgrep 'p/*/`abgrep`/'
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 Show lines that contain foo, bar, AND baz (in no particular order), but do not contain qux NOR quux
 % abgrep --all --dash-prefix-inverts -e foo -e bar -e baz -e -qux -e -quux
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/App-abgrep>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-App-abgrep>.
=head1 SEE ALSO
L<grep-terms>.
=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, 2022, 2021, 2020, 2018 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-abgrep>
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