44 stable releases
2.100.52 | Mar 10, 2023 |
---|---|
2.100.50 | Feb 28, 2023 |
2.100.47 | Dec 16, 2022 |
2.100.46 | Nov 24, 2022 |
2.100.22 | Mar 31, 2022 |
#119 in Testing
78 downloads per month
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.52
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
Dependencies
~7–12MB
~231K SLoC