The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-wordlist-0.292
River stage one • 2 direct dependents • 4 total dependents
++
/ wordlist

NAME

wordlist - Grep words from (or test them against) WordList::*

VERSION

This document describes version 0.292 of main::_DataPacker (from Perl distribution App-wordlist), released on 2024-01-05.

SYNOPSIS

wordlist --help (or -h, -?)

wordlist --version (or -v)

wordlist [--action=str|-L|-l|-s|-t] [--chars-ordered=str] [--chars-unordered=str] [--color=str] [(--config-path=path)+|--no-config] [--config-profile=profile] [--debug|--log-level=level|--quiet|--trace|--verbose] [--detail|--no-detail|--nodetail] [--exclude-dynamic-wordlists|-D|--include-dynamic-wordlists] [--exclude-wordlist-pattern=re_from_str|-P=re_from_str] [(--exclude-wordlist=str)+|--exclude-wordlists-json=json|(-X=str)+] [--format=name|--json] [--ignore-case|-i|--no-ignore-case|--noignore-case] [(--lang=str)+|--langs-json=json] [--lcpan|--no-lcpan|--nolcpan] [--len=int] [--max-len=int] [--min-len=int] [--(no)naked-res] [--no-env] [--num=int|-n=int] [--or|--no-or|--noor] [--page-result[=program]|--view-result[=program]] [--random|-r|--no-random|--norandom] [(--wordlist-bundle=str)+|--wordlist-bundles-json=json|(-b=str)+] [(--wordlist=str)+|--wordlists-json=json|(-w=str)+] -- [arg] ...

See examples in the "EXAMPLES" section.

OPTIONS

* marks required options.

Main options

--action=s

Default value:

 "grep"

Valid values:

 ["list_cpan","list_installed","list_selected","grep","stat","test"]

Action list_installed (shortcut option -l) will list WordList::* modules installed on the local system.

Action list_cpan (shortcut option -L) will list available WordList::* modules on CPAN, either by querying the MetaCPAN site or by querying a local mini CPAN using App::lcpan.

Action list_selected (option --action=list_selected) will list the selected WordList::* modules (e.g. via -w or -b).

Action grep (the default action) will filter the words from each selected wordlists and print them.

Action stat (shortcut option -s) will show statistics about all the selected wordlists.

Action test (shortcut option -t) will check whether words are in one of the wordlist, using word_exists() method on each wordlist.

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

--lcpan

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

--num=s, -n

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

Default value:

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

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

-t

Test whether words exists in wordlist.

See --action.

Configuration options

--config-path=s

Set path to configuration file.

Can actually be specified multiple times to instruct application to read from multiple configuration files (and merge them).

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

A single configuration file can contain profiles, i.e. alternative sets of values that can be selected. For example:

 [profile=dev]
 username=foo
 pass=beaver
 
 [profile=production]
 username=bar
 pass=honey

When you specify --config-profile=dev, username will be set to foo and password to beaver. When you specify --config-profile=production, username will be set to bar and password to honey.

--no-config

Do not use any configuration file.

If you specify --no-config, the application will not read any configuration file.

Environment options

--no-env

Do not read environment for default options.

If you specify --no-env, the application wil not read any environment variable.

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.

Module selection options

--exclude-dynamic-wordlists, -D

(No description)

--exclude-wordlist-pattern=s, -P

(No description)

--exclude-wordlist=s@, -X

Exclude wordlist modules.

Can be specified multiple times.

--exclude-wordlists-json=s

Exclude wordlist modules (JSON-encoded).

See --exclude-wordlist.

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

--wordlist-bundle=s@, -b

Select one or more wordlist bundle (Acme::CPANModules::WordListBundle::*) modules.

Can be specified multiple times.

--wordlist-bundles-json=s

Select one or more wordlist bundle (Acme::CPANModules::WordListBundle::*) modules (JSON-encoded).

See --wordlist-bundle.

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

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.

Word filtering options

--arg-json=s

See --arg.

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

--arg=s@

(No description)

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

Can be specified multiple times.

--chars-ordered=s

Specify possible characters for the word (ordered).

--chars-unordered=s

Specify possible characters for the word (unordered).

--len=s

(No description)

--max-len=s

(No description)

--min-len=s

(No description)

--no-ignore-case, -i

(No description)

--or

Instead of printing words that must match all queries (the default), print words that match any query.

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.

FAQ

How to select multiple wordlists? It's cumbersome having to -w WORDLIST1 -w WORDLIST2 and so on!

You can specify wildcard in -w option, e.g. if you want to include all English wordlists you can use -w EN::* or -w EN::** (** recurses while * only matches one level deep).

Or you can also use -b option. Some people bundle wordlists together and put them up on CPAN in the Acme::CPANModules::WordListBundle::* namespace. You can install those modules first then use the wordlist bundle.

Can wordlist help me solve Wordle?

Yes, using regex or the --chars-ordered and --chars-unordered options. For example, if you have:

 T W _ S _

(3 letters with the correct position), you can use:

 % wordlist -w EN::Wordle '/^tw.s./' --len 5
 twist

or:

 % wordlist -w EN::Wordle --chars-ordered tws --len 5
 tawse
 thaws
 ...
 twist
 twits

Another example, if you have:

 W* T* _ S _

(2 letters with the incorrect position and 1 letter in the correct position), you can use:

 % wordlist -w EN::Wordle --chars-unordered wts --len 5 '/^...s.$/'

Included in the distribution is the wordlist-wordle script for convenience. This CLI defaults to grepping the "EN::Wordle" wordlist and you specify something like wt_S_ for the pattern (lowercase for letter in incorrect position, uppercase for letter in correct position, underscore for unguessed):

 % wordlist-wordle 'wt_S_'

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.

You can also 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 equals some string: [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 some string: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when the value of an environment variable includes some string: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. If you only want a section to be read when the value of an environment variable does not include some string: [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.

To load and configure plugins, you can use either the -plugins parameter (e.g. -plugins=DumpArgs or -plugins=DumpArgs@before_validate_args), or use the [plugin=NAME ...] sections, for example:

 [plugin=DumpArgs]
 -event=before_validate_args
 -prio=99
 
 [plugin=Foo]
 -event=after_validate_args
 arg1=val1
 arg2=val2

which is equivalent to setting -plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2.

List of available configuration parameters:

 action (see --action)
 arg (see --arg)
 chars_ordered (see --chars-ordered)
 chars_unordered (see --chars-unordered)
 color (see --color)
 detail (see --detail)
 exclude_dynamic_wordlists (see --exclude-dynamic-wordlists)
 exclude_wordlist_pattern (see --exclude-wordlist-pattern)
 exclude_wordlists (see --exclude-wordlist)
 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)
 wordlist_bundles (see --wordlist-bundle)
 wordlists (see --wordlist)

ENVIRONMENT

WORDLIST_OPT

String. Specify additional command-line options.

FILES

~/.config/wordlist.conf

~/wordlist.conf

/etc/wordlist.conf

EXAMPLES

By default print all words from all wordlists

 % wordlist
 % wordlist -D
 % wordlist foo bar
 % wordlist --or foo bar
 % 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 a bunch of wordlists via wordlist bundle (Acme::CPANModules::WordListBundle::* module)

 % wordlist -b Proverbs foo

An alternative to select all proverb wordlists

 % wordlist -w 'Phrase::**::Proverb::**' foo

Check to see which wordlists we are selecting via `-w` with wildcards or via `-b`

 % wordlist -w 'Phrase::**::Proverb::**' '--action=list_selected'
 % wordlist -w EN::Enable --len 6 -i --chars-unordered bobleg
 % wordlist -w EN::Enable --len 6 -i --chars-ordered BGL

Select French wordlists (multiple --lang allowed)

 % wordlist --lang FR foo

Filter by regex

 % wordlist '/fof[aeiou]/'

Select a wordlist with parameters

 % wordlist -w 'MetaSyntactic=theme,dangdut'

List installed wordlist modules

 % wordlist -l

List wordlist modules available on CPAN

 % wordlist -L

Show statistics of a wordlist module

 % wordlist -w ID::KBBI -s

Check some passwords against a password wordlist

 % wordlist -w Password::RockYou::BloomOnly -t foobar 123456 someGoodPass923

Check some passwords against all Password wordlists except Password::RockYou (because it is slow to check)

 % wordlist -w 'Password::**' -X Password::RockYou -t foobar 123456 someGoodPass923

Check some passwords against all Password wordlists except those matching /RockYou/ regex

 % wordlist -w 'Password::**' -P RockYou -t foobar 123456 someGoodPass923

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.

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, 2022, 2021, 2020, 2018, 2017, 2016, 2015, 2014 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-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.