/ 
App-wordlist-0.276
River stage one • 2 direct dependents • 4 total dependents
/ wordlist

NAME

wordlist - Grep words from WordList::*

VERSION

This document describes version 0.276 of main (from Perl distribution App-wordlist), released on 2020-06-09.

SYNOPSIS

Usage:

% wordlist [-L] [--action=s] [--color=s] [--config-path=path+]
    [--config-profile=profile] [--debug] [--detail] [--format=name]
    [--ignore-case] [--json] [-l] [--lang=s+] [--langs-json=s] [--lcpan]
    [--len=s] [--log-level=level] [--max-len=s] [--min-len=s] [-n=s]
    [--(no)naked-res] [--no-config] [--no-detail] [--no-env]
    [--no-ignore-case] [--no-lcpan] [--no-or] [--no-random] [--nodetail]
    [--noignore-case] [--nolcpan] [--noor] [--norandom] [--num=s] [--or]
    [--page-result[=program]] [--quiet] [-r] [--random] [-s] [--trace]
    [--verbose] [--view-result[=program]] [-w=s+] [--wordlist=s+]
    [--wordlists-json=s] [arg] ...

Examples:

By default print all words from all wordlists:

% wordlist

Print all words matching /foo/ and /bar/:

% wordlist foo bar

Print all words matching /foo/ or /bar/:

% wordlist --or foo bar

Print wordlist name for each matching words:

% wordlist --detail foo

Select a specific wordlist (multiple -w allowed):

% wordlist -w ID::KBBI foo

Select all ID::* wordlists (wildcard will be expanded):

% wordlist -w 'ID::**' foo

Select French wordlists (multiple --lang allowed):

% wordlist --lang FR foo

Filter by regex:

% wordlist '/fof[aeiou]/'

List installed wordlist modules:

% wordlist -l

List wordlist modules available on CPAN:

% wordlist -L

OPTIONS

* marks required options.

Main options

--action=s

Default value:

"grep"

Valid values:

["list_cpan","list_installed","grep","stat"]
--arg-json=s

See --arg.

--arg=s@

Can be specified multiple times.

--color=s

When to highlight search string/matching pattern with color.

Default value:

"auto"

Valid values:

["never","always","auto"]
--detail

Display more information when listing modules/result.

When listing installed modules (`-l`), this means also returning a wordlist's language.

When returning grep result, this means also returning wordlist name.

--lang=s@

Only include wordlists of certain language(s).

By convention, language code is the first subnamespace of a wordlist module, e.g. WordList::EN::* for English, WordList::FR::* for French, and so on. Wordlist modules which do not follow this convention (e.g. WordList::Password::* or WordList::PersonName::*) are not included.

Can be specified multiple times.

--langs-json=s

Only include wordlists of certain language(s) (JSON-encoded).

See --lang.

--lcpan

Use local CPAN mirror first when available (for -L).

--len=s
--max-len=s
--min-len=s
--no-ignore-case
--num=s, -n

Return (at most) this number of words (0 = unlimited).

Default value:

0
--or

Match any word in query instead of the default "all".

--random, -r

Pick random words.

If set to true, then streaming will be turned off. All words will be gathered first, then words will be chosen randomly from the gathered list.

--wordlist=s@, -w

Select one or more wordlist modules.

Can be specified multiple times.

--wordlists-json=s

Select one or more wordlist modules (JSON-encoded).

See --wordlist.

-l

List installed WordList::* modules.

See --action.

-L

List WordList::* modules on CPAN.

See --action.

-s

Show statistics contained in the wordlist modules.

See --action.

Configuration options

--config-path=s

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--no-config

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--format=s

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

Default value:

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

--view-result

View output using a viewer.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

The script comes with a companion shell completer script (_wordlist) for this script.

bash

To activate bash completion for this script, put:

complete -C _wordlist wordlist

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

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.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/wordlist.conf, ~/wordlist.conf, or /etc/wordlist.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

action (see --action)
arg (see --arg)
color (see --color)
detail (see --detail)
format (see --format)
ignore_case (see --no-ignore-case)
langs (see --lang)
lcpan (see --lcpan)
len (see --len)
log_level (see --log-level)
max_len (see --max-len)
min_len (see --min-len)
naked_res (see --naked-res)
num (see --num)
or (see --or)
random (see --random)
wordlists (see --wordlist)

ENVIRONMENT

WORDLIST_OPT => str

Specify additional command-line options.

FILES

~/.config/wordlist.conf

~/wordlist.conf

/etc/wordlist.conf

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-App-wordlist.

BUGS

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

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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