grep-email - Print lines having email address(es) (optionally of certain criteria) in them
This document describes version 0.001 of grep-email (from Perl distribution App-grep-email), released on 2021-08-02.
Usage:
% grep-email [--address-contains=str] [--address-matches=re] [--address-not-contains=str] [--color=str] [--comment-contains=str] [--comment-matches=re] [--comment-not-contains=str] [--count|-c] [--debug|--log-level=level|--quiet|--trace|--verbose] [(--file=filename)+] [--format=name|--json] [--host-contains=str] [--host-matches=re] [--host-not-contains=str] [--ignore-case|-i|--no-ignore-case|--noignore-case] [--invert-match|-v|--no-invert-match|--noinvert-match] [--line-number|-n] [--max-emails=int] [--min-emails=uint] [--(no)naked-res] [--name-contains=str] [--name-matches=re] [--name-not-contains=str] [--page-result[=program]|--view-result[=program]] [--quiet-arg] [--user-contains=str] [--user-matches=re] [--user-not-contains=str] [--files-json=json] [-q|--silent] -- [file] ...
Examples:
Show lines that contain at least 2 emails:
% grep-email --min-emails 2 file.txt
Show lines that contain emails from gmail:
% grep-email --host-contains gmail.com file.txt
This is a grep-like utility that greps for emails of certain criteria.
* marks required options.
*
Can also be specified as the 1st command-line argument and onwards.
Can be specified multiple times.
See --file.
--file
Default value:
-1
1
"auto"
Valid values:
["never","always","auto"]
Supress normal output, return a count of matching lines.
Shortcut for --log-level=debug.
Set log level.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Invert the sense of matching.
Choose output format, e.g. json, text.
undef
Set output format to json.
When outputing as JSON, strip result envelope.
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 `--naked-res` so you just get:
[1,2,3]
Filter output through a pager.
View output using a viewer.
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C grep-email grep-email
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 grep-email 'p/*/`grep-email`/'
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-grep-email.
Source repository is at https://github.com/perlancar/perl-App-grep-email.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-grep-email
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.
grep-url.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2021 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.
To install App::grep::email, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::grep::email
CPAN shell
perl -MCPAN -e shell install App::grep::email
For more information on module installation, please visit the detailed CPAN module installation guide.