cli

README

wordgen/cli

A CLI program that prints random words. You can customize the word case, separator, number of words, and wordlist used.

Installation

AUR

You can use your preferred AUR helper, or manually clone and run makepkg, to install wordgen or wordgen-bin.

Non-AUR

Release Binary

Each release contains several binaries. Download the binary for your operating system, then put it in your PATH.

Build From Source

If you wish to build the binary from source, you will need a few things installed: git go make

Clone the repository and run make inside the directory:

git clone https://github.com/wordgen/cli.git
cd cli
make

Then run make install with root privileges to install:

sudo make install

To uninstall:

sudo make uninstall

Usage

See wordgen -h for a full list of options.

Example output:

$ wordgen
vixen

$ wordgen -w 5
hunting clock buffoon trodden deflation

$ wordgen -w 5 -s . -c title
Ditch.Dealer.Flammable.Unearth.Yonder

Wordlists

The wordlists used in this program are from the wordgen/wordlists repository. You can switch which wordlist the words are generated from with the -l, --list option.

You can also use a local wordlist file with the -f, --file option. The file must be a text file with one word per line.

Reproducible Builds

Each release binary is built using the Dockerfile and Makefile. This enables you to easily verify them by building one yourself and comparing the checksums.

For example, to build a Linux amd64 binary, run the following command in the repository directory:

make linux-amd64

The resulting binary will be located in the bin directory, compressed into an archive for distribution.

Contributing

When submitting a pull request, please ensure they are directed to the dev branch of the repository.

Ensure your commit messages and pull request titles follow the Conventional Commits specification.

License

All files in this repository are licensed under the GNU Affero General Public License v3.0 or later - see the LICENSE file for details.