https://github.com/eluciusftw/wordle-assistant
A CLI assisting you with your wordle struggles by suggesting words and helping you find words when you want to eliminate certain letters.
https://github.com/eluciusftw/wordle-assistant
cli fun wordle worlde-solver
Last synced: 1 day ago
JSON representation
A CLI assisting you with your wordle struggles by suggesting words and helping you find words when you want to eliminate certain letters.
- Host: GitHub
- URL: https://github.com/eluciusftw/wordle-assistant
- Owner: EluciusFTW
- Created: 2022-06-12T16:40:03.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-10T14:40:35.000Z (9 months ago)
- Last Synced: 2024-08-10T15:51:23.158Z (9 months ago)
- Topics: cli, fun, wordle, worlde-solver
- Language: F#
- Homepage:
- Size: 528 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Wassi CLI
## Introduction
Wordle is currently abundant, and I have dabbled with it every now and then again. Last weekend I got a bit bored and felt the itch to write some F# again. I had also wanted to try using Spectre.Console in F# for a while. So writing a small CLI that assists me with the game of wordle seemed like a fun idea.
## Disclaimer
This is just a fun project. It uses a very naive counting strategy to rank words. I know there are many better tools out there that take this more seriously. I purposely didn't look at any of them, nor did I want to spend more than a day figuring this out.
## Wassi.CLI
Wassi (short for Wordle-assistant) uses [Spectre.Console](https://github.com/spectreconsole/spectre.console) and works command-based. It currently has three commands.
### Suggest
The suggest command will suggest words, ranked by their score, that fit your current _progress_ and the letters you have already _excluded_. This is an example of a usage:
```PS
.\Wassi.exe suggest -p .A..s -e kltd -n 7
````
The parameter
* `(-p|--progress)` defines the progress. Has to be a five character string. Capital letters inidcate exact hits (green in wordle), lower-case letters occurrences in the word at the wrong position (yellow in wordle). If this parameter is omitted, it is interpreted as the starting point.
* `(-e|--excluding)` provides the excluded letters as a gap-less string. If this parameter is omitted, no letters are excluded.
* `(-w|--wordlist)` provides a path to a file containing the words to be used (default: "./word-lists/words.txt").
* `-n` indicates the number of results to be shown (default: 10).
### Find
The find command helps you find a word containing given letters, which can be helpful if you want to eliminate multiple ones but can't think of a word containing them.
```PS
.\Wassi.exe find -i cko
````
Here, the parameter `(-i|--including)` provides the letters that should be included. Both `-w` for providing the word list as well as `-n` for the amount of results can be used with this command as well.
### Rate
The rate command will show you the score a given word has, under the current progress, taking into account excluded letters, thereby rating it.
```PS
.\Wassi.exe rate -c joker -p J..r. -e afv
````
The word that is to be raten has to be provided via `(-c|--candidate)` and it has to be exactly 5 characters long. The _progress_ and the _excluded letters_ can be optionally provided it the same way as in the suggest command.
### Sample
Here is a small sample of Wassi in action. It is based on the word list that can be [found here](https://github.com/tabatkins/wordle-list).
## Feedback and Contributing
All feedback welcome!
All contributions are welcome!