Readable Name Generator

Generate a readable name for throwaway infrastructure

Usage

Basic Usage

shell,script(name="random_name") readable-name-generator

shell,skip() capable_munson

Reproducing names

shell,script(name="running") readable-name-generator --initial-seed 1

shell,verify(script_name="running") gregarious_pauli

Changing the separator

shell,script(name="seperator") readable-name-generator --initial-seed 1 --separator "###"

shell,verify(script_name="seperator") gregarious###pauli

Full usage

shell,script(name="help") readable-name-generator --help

``` shell,verify(script_name="help") Generate a readable name for throwaway infrastructure

Usage: readable-name-generator [OPTIONS]

Options: -s, --separator The separator to use [env: READABLENAMEGENERATORSEPARATOR=] [default: _] -i, --initial-seed Use a known seed to generate the readable name for repeatability [env: READABLENAMEGENERATORINITIALSEED=] -c, --completion-shell Generate completion for your shell [env: COMPLETIONSHELL=] [possible values: bash, elvish, fish, powershell, zsh] -h, --help Print help -V, --version Print version ```

Docker

We also have a docker image

shell,skip() docker run --rm -it ghcr.io/purplebooth/readable-name-generator:latest -i 1

shell,skip() gregarious_pauli

Installing

Download the latest release and run it. I install it with homebrew. Or you could use docker.

Homebrew

shell,skip() brew install PurpleBooth/repo/readable-name-generator

Binaries

Binaries for Windows, Linux and MacOS are available on the releases page

Development

Testing

To run the tests, run

shell,skip() just test

To run the end-to-end tests, run

shell,skip() just specdown

Automatic Code Formatting

To automatically tidy up the code in whatever way possible run

shell,skip() just fmt

Building docker

We have a docker container

shell,skip() docker build -t "ghcr.io/purplebooth/readable-name-generator:latest" docker run --rm -it ghcr.io/purplebooth/readable-name-generator:latest -i 1

shell,skip() gregarious_pauli

License

CC0 1.0 Universal.