# Note: This script is a CLI for Riap function /App/CSVUtils/csv_grep
# and generated automatically using Perinci::CmdLine::Gen version 0.496

our $DATE = '2020-05-29'; # DATE
our $DIST = 'App-CSVUtils'; # DIST
our $VERSION = '0.029'; # VERSION

use 5.010001;
use strict;
use warnings;

use Perinci::CmdLine::Any;

my $cmdline = Perinci::CmdLine::Any->new(
    url => "/App/CSVUtils/csv_grep",
    program_name => "csv-grep",
    read_config => 0,
    read_env => 0,


# ABSTRACT: Only output row(s) where Perl expression returns true
# PODNAME: csv-grep



=encoding UTF-8

=head1 NAME

csv-grep - Only output row(s) where Perl expression returns true

=head1 VERSION

This document describes version 0.029 of csv-grep (from Perl distribution App-CSVUtils), released on 2020-05-29.



 % csv-grep [-H] [-e=s] [--eval-json=s] [--eval=s] [--format=name] [--hash] [--header] [--json] [--(no)naked-res] [--no-header] [--no-tsv] [--noheader] [--notsv] [--page-result[=program]] [--tsv] [--view-result[=program]] <filename>


Only show rows where the amount field is divisible by 7:

 % csv-grep -He '$_->{amount} % 7 ? 1:0' file.csv

Only show rows where date is a Wednesday:

 % csv-grep -He 'BEGIN { use DateTime::Format::Natural; $parser = DateTime::Format::Natural->new } $dt = $parser->parse_datetime($_->{date}); $dt->day_of_week == 3' file.csv


This is like Perl's C<grep> performed over rows of CSV. In C<$_>, your Perl code
will find the CSV row as an arrayref (or, if you specify C<-H>, as a hashref).
C<$main::row> is also set to the row (always as arrayref). C<$main::rownum>
contains the row number (2 means the first data row). C<$main::csv> is the
L<Text::CSV_XS> object. C<$main::field_idxs> is also available for additional

Your code is then free to return true or false based on some criteria. Only rows
where Perl expression returns true will be included in the result.

=head1 OPTIONS

C<*> marks required options.

=head2 Main options


=item B<--eval-json>=I<s>, B<-e>

Perl code (JSON-encoded).

See C<--eval>.

=item B<--eval>=I<s>*

Perl code.

=item B<--filename>=I<s>*, B<-f>

Input CSV file.

Use `-` to read from stdin.

=item B<--hash>, B<-H>

Provide row in $_ as hashref instead of arrayref.

=item B<--no-header>

By default (`--header`), the first row of the CSV will be assumed to contain
field names (and the second row contains the first data row). When you declare
that CSV does not have header row (`--no-header`), the first row of the CSV is
assumed to contain the first data row. Fields will be named `field1`, `field2`,
and so on.

=item B<--tsv>

Inform that input file is in TSV (tab-separated) format instead of CSV.


=head2 Output options


=item B<--format>=I<s>

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

Default value:


=item B<--json>

Set output format to json.

=item B<--naked-res>

When outputing as JSON, strip result envelope.

Default value:


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:


=item B<--page-result>

Filter output through a pager.

=item B<--view-result>

View output using a viewer.


=head2 Other options


=item B<--help>, B<-h>, B<-?>

Display help message and exit.

=item B<--version>, B<-v>

Display program's version and exit.



This script has shell tab completion capability with support for several

=head2 bash

To activate bash completion for this script, put:

 complete -C csv-grep csv-grep

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

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.


Please visit the project's homepage at L<https://metacpan.org/release/App-CSVUtils>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-App-CSVUtils>.

=head1 BUGS

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

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

=head1 SEE ALSO


=head1 AUTHOR

perlancar <perlancar@cpan.org>


This software is copyright (c) 2020, 2019, 2018, 2017, 2016 by 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.