/ 
App-grep-similar-text-0.002
River stage zero No dependents
/ grep-similar-text

NAME

grep-similar-text - Print lines similar to the specified text

VERSION

This document describes version 0.002 of grep-similar-text (from Perl distribution App-grep-similar-text), released on 2024-11-20.

SYNOPSIS

grep-similar-text --help (or -h, -?)

grep-similar-text --version (or -v)

grep-similar-text [--color=str] [--count|-c] [--debug|--log-level=level|--quiet|--trace|--verbose] [(--file=filename)+|--files-json=json] [--files-with-matches|-l] [--files-without-match|-L] [--format=name|--json] [--ignore-case|-i|--no-ignore-case|--noignore-case] [--invert-match|-v|--no-invert-match|--noinvert-match] [--line-number|-n] [--max-edit-distance=uint] [--(no)naked-res] [--page-result[=program]|--view-result[=program]] [--quiet-arg|-q|--silent] -- <string> [file] ...

See examples in the "EXAMPLES" section.

DESCRIPTION

This is a grep-like utility that greps for text in input similar to the specified text. Measure of similarity can be adjusted using these options: --max-edit-distance (-M).

OPTIONS

* marks required options.

Main options

--file=s@

(No description)

Can also be specified as the 2nd command-line argument and onwards.

Can be specified multiple times.

--files-json=s

See --file.

Can also be specified as the 2nd command-line argument and onwards.

Filtering options

--max-edit-distance=s

If not specified, a sensible default will be calculated as follow:

int( min(len(text), len(input_text)) / 1.3)
--string=s*

String to compare similarity of each line of input to.

Can also be specified as the 1st command-line argument.

General output control options

--color=s

Specify when to show color (never, always, or auto/when interactive).

Default value:

"auto"

Valid values:

["never","always","auto"]
--count, -c

Supress normal output; instead return a count of matching lines.

--files-with-matches, -l

Supress normal output; instead return filenames with matching lines; scanning for each file will stop on the first match.

--files-without-match, -L

Supress normal output; instead return filenames without matching lines.

--quiet-arg, --silent, -q

Do not print matches, only return appropriate exit code.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

By default, these log levels are available (in order of increasing level of importance, from least important to most): trace, debug, info, warn/warning, error, fatal. By default, the level is usually set to warn, which means that log statements with level info and less important levels will not be shown. To increase verbosity, choose info, debug, or trace.

For more details on log level and logging, as well as how new logging levels can be defined or existing ones modified, see Log::ger.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Matching control options

--ignore-case, -i

If set to true, will search case-insensitively.

--invert-match, -v

Invert the sense of matching.

Output line prefix control options

--line-number, -n

Show line number along with matches.

Output options

--format=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.

--json

Set output format to json.

--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 --naked-res so you just get:

[1,2,3]
--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. less is chosen.

--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.

Other options

--help, -h, -?

Display help message and exit.

--version, -V

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C grep-similar-text grep-similar-text

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.

tcsh

To activate tcsh completion for this script, put:

complete grep-similar-text 'p/*/`grep-similar-text`/'

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).

other shells

For fish and zsh, install shcompgen as described above.

EXAMPLES

Show lines that are similar to the text "foobar"

% grep-similar-text foobar file.txt

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-grep-similar-text.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-grep-similar-text.

SEE ALSO

grep-sounds-like.

AUTHOR

perlancar <perlancar@cpan.org>

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 Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, 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.

COPYRIGHT AND LICENSE

This software is copyright (c) 2024 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.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-grep-similar-text

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.