wordlist-wordle - Help solve Wordle
This document describes version 0.292 of main::_DataPacker (from Perl distribution App-wordlist), released on 2024-01-05.
wordlist-wordle --help (or -h, -?)
wordlist-wordle --version (or -v)
wordlist-wordle [--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] [--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.
This is a wrapper to wordlist designed to be a convenient helper to solve Wordle puzzle. By default it greps from the EN::Wordle wordlist. It accepts a series of guesses in a format like the following:
EN::Wordle
A^R^isE^ Pound might blA^ck PR^ivY^
where lowercase means wrong guess, uppercase means correct letter and position, while (uppercase) letter followed by a caret (^) means the letter exists in another position. It will convert these guesses to regex patterns and the --chars-unordered option and pass it to wordlist.
^
--chars-unordered
wordlist
* marks required options.
*
When to highlight search string/matching pattern with color.
Default value:
"auto"
Valid values:
["never","always","auto"]
Display more information when listing modules/result.
When listing installed modules (-l), this means also returning a wordlist's language.
-l
When returning grep result, this means also returning wordlist name.
Return (at most) this number of words (0 = unlimited).
0
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.
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.
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.
--config-profile=dev
username
foo
password
beaver
--config-profile=production
bar
honey
Do not use any configuration file.
If you specify --no-config, the application will not read any configuration file.
--no-config
Do not read environment for default options.
If you specify --no-env, the application wil not read any environment variable.
--no-env
Shortcut for --log-level=debug.
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.
trace
debug
info
warn
warning
error
fatal
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.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
(No description)
Exclude wordlist modules.
Exclude wordlist modules (JSON-encoded).
See --exclude-wordlist.
--exclude-wordlist
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.
Only include wordlists of certain language(s) (JSON-encoded).
See --lang.
--lang
Select one or more wordlist bundle (Acme::CPANModules::WordListBundle::*) modules.
Select one or more wordlist bundle (Acme::CPANModules::WordListBundle::*) modules (JSON-encoded).
See --wordlist-bundle.
--wordlist-bundle
Select one or more wordlist modules.
["EN::Wordle"]
Select one or more wordlist modules (JSON-encoded).
See --wordlist.
--wordlist
Choose output format, e.g. json, text.
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.
Set output format to json.
When outputing as JSON, strip result envelope.
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:
--naked-res
[1,2,3]
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.
less
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.
See --arg.
--arg
Can also be specified as the 1st command-line argument and onwards.
5
Instead of printing words that must match all queries (the default), print words that match any query.
Display help message and exit.
Display program's version and exit.
The script comes with a companion shell completer script (_wordlist-wordle) for this script.
To activate bash completion for this script, put:
complete -C _wordlist-wordle wordlist-wordle
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 wordlist-wordle 'p/*/`wordlist-wordle`/'
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.
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-wordle.conf, ~/wordlist-wordle.conf, or /etc/wordlist-wordle.conf.
--config-path
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.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
--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.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
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.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
[env=HOSTNAME!*=server ...]
[SOMESECTION env=HOSTNAME!*=server ...]
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:
-plugins
-plugins=DumpArgs
-plugins=DumpArgs@before_validate_args
[plugin=NAME ...]
[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.
-plugins=-DumpArgs@before_validate_args@99,-Foo@after_validate_args,arg1,val1,arg2,val2
List of available configuration parameters:
arg (see --arg) 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) 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)
String. Specify additional command-line options.
% wordlist-wordle cR^eEk
% wordlist-wordle A^R^isE^ Pound might blA^ck PR^ivY^
Please visit the project's homepage at https://metacpan.org/release/App-wordlist.
Source repository is at https://github.com/perlancar/perl-App-wordlist.
perlancar <perlancar@cpan.org>
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.
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.
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.
To install App::wordlist, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::wordlist
CPAN shell
perl -MCPAN -e shell install App::wordlist
For more information on module installation, please visit the detailed CPAN module installation guide.