readable-name-generator
| Crates.io | readable-name-generator |
| lib.rs | readable-name-generator |
| version | |
| source | src |
| created_at | 2022-02-19 15:56:08.934058 |
| updated_at | 2024-12-06 02:26:11.459467 |
| description | Generate a readable name for throwaway infrastructure |
| homepage | |
| repository | https://github.com/PurpleBooth/anarchist-readable-name-generator-lib.git |
| max_upload_size | |
| id | 535249 |
| Cargo.toml error: | TOML parse error at line 17, column 1 | 17 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Billie Thompson (PurpleBooth)
documentation
README
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
Generate a readable name for throwaway infrastructure
Usage: readable-name-generator [OPTIONS]
Options:
-s, --separator <SEPARATOR>
The separator to use [env: READABLE_NAME_GENERATOR_SEPARATOR=] [default: _]
-i, --initial-seed <INITIAL_SEED>
Use a known seed to generate the readable name for repeatability [env:
READABLE_NAME_GENERATOR_INITIAL_SEED=]
-c, --completion-shell <COMPLETION_SHELL>
Generate completion for your shell [env: COMPLETION_SHELL=] [possible values: bash,
elvish, fish, powershell, zsh]
-h, --help
Print help
-V, --version
Print version
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