#names #utility

app readable-name-generator

Generate a readable name for throwaway infrastructure

24 stable releases

Uses new Rust 2021

new 2.100.32 May 11, 2022
2.100.31 May 9, 2022
2.100.27 Apr 25, 2022
2.100.22 Mar 31, 2022
2.100.17 Feb 28, 2022

#47 in Testing

Download history 53/week @ 2022-02-14 97/week @ 2022-02-21 61/week @ 2022-02-28 22/week @ 2022-03-07 58/week @ 2022-03-14 36/week @ 2022-03-21 57/week @ 2022-03-28 53/week @ 2022-04-04 9/week @ 2022-04-11 49/week @ 2022-04-18 138/week @ 2022-04-25 202/week @ 2022-05-02 102/week @ 2022-05-09

491 downloads per month

CC0 license

495KB
3K SLoC

Readable Name Generator

Generate a readable name for throwaway infrastructure

Usage

Basic Usage

readable-name-generator
capable_munson

Reproducing names

readable-name-generator --initial-seed 1
gregarious_pauli

Changing the separator

readable-name-generator --initial-seed 1 --separator "###"
gregarious###pauli

Full usage

readable-name-generator --help
readable-name-generator 2.100.32

Generate a readable name for throwaway infrastructure

USAGE:
    readable-name-generator [OPTIONS]

OPTIONS:
    -c, --completion <completion_shell>
            Generate completion for your shell [possible values: bash, elvish, fish, powershell,
            zsh]

    -h, --help
            Print help information

    -i, --initial-seed <initial_seed>
            Use a known seed to generate the readable name for repeatability [env:
            READABLE_NAME_GENERATOR_INITIAL_SEED=]

    -s, --separator <separator>
            The separator to use [env: READABLE_NAME_GENERATOR_SEPARATOR=] [default: _]

    -V, --version
            Print version information

Docker

We also have a docker image

docker run --rm -it ghcr.io/purplebooth/readable-name-generator:latest -i 1
gregarious_pauli

Installing

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

Homebrew

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

just test

To run the end-to-end tests, run

just specdown

Automatic Code Formatting

To automatically tidy up the code in whatever way possible run

just fmt

Building docker

We have a docker container

docker build -t "ghcr.io/purplebooth/readable-name-generator:latest"
docker run --rm -it ghcr.io/purplebooth/readable-name-generator:latest -i 1
gregarious_pauli

License

CC0 1.0 Universal.

Dependencies

~7MB
~141K SLoC