{"id":26368285,"url":"https://github.com/PurpleBooth/readable-name-generator","last_synced_at":"2025-03-16T22:28:42.923Z","repository":{"id":37579969,"uuid":"220548036","full_name":"PurpleBooth/readable-name-generator","owner":"PurpleBooth","description":"Generates readable names for things like throwaway infrastructure","archived":false,"fork":false,"pushed_at":"2024-10-25T19:50:14.000Z","size":669,"stargazers_count":6,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-29T22:34:15.475Z","etag":null,"topics":["docker","shell-script","utils"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PurpleBooth.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["PurpleBooth"],"patreon":null,"open_collective":null,"ko_fi":"billie","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-11-08T21:09:33.000Z","updated_at":"2024-10-25T19:50:18.000Z","dependencies_parsed_at":"2024-04-22T20:52:40.848Z","dependency_job_id":"bc09a3bb-e4ec-40d1-bd4c-2bb0c5688d29","html_url":"https://github.com/PurpleBooth/readable-name-generator","commit_stats":null,"previous_names":["purplebooth/moby-name-generator"],"tags_count":272,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PurpleBooth%2Freadable-name-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PurpleBooth%2Freadable-name-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PurpleBooth%2Freadable-name-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PurpleBooth%2Freadable-name-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PurpleBooth","download_url":"https://codeload.github.com/PurpleBooth/readable-name-generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243652699,"owners_count":20325610,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","shell-script","utils"],"created_at":"2025-03-16T22:28:42.000Z","updated_at":"2025-03-16T22:28:42.918Z","avatar_url":"https://github.com/PurpleBooth.png","language":"Rust","funding_links":["https://github.com/sponsors/PurpleBooth","https://ko-fi.com/billie"],"categories":[],"sub_categories":[],"readme":"# Readable Name Generator\n\nGenerate a readable name for throwaway infrastructure\n\n## Usage\n\n### Basic Usage\n\n``` shell,script(name=\"random_name\")\nreadable-name-generator\n```\n\n``` shell,skip()\ncapable_munson\n```\n\n### Reproducing names\n\n``` shell,script(name=\"running\")\nreadable-name-generator --initial-seed 1\n```\n\n``` shell,verify(script_name=\"running\")\nflexible_briseglace\n```\n\n### Changing the separator\n\n``` shell,script(name=\"seperator\")\nreadable-name-generator --initial-seed 1 --separator \"###\"\n```\n\n``` shell,verify(script_name=\"seperator\")\nflexible###briseglace\n```\n\n### Full usage\n\n``` shell,script(name=\"help\")\nreadable-name-generator --help\n```\n\n``` shell,verify(script_name=\"help\")\nGenerate a readable name for throwaway infrastructure\n\nUsage: readable-name-generator [OPTIONS]\n\nOptions:\n  -s, --separator \u003cSEPARATOR\u003e\n          The separator to use [env: READABLE_NAME_GENERATOR_SEPARATOR=] [default: _]\n  -i, --initial-seed \u003cINITIAL_SEED\u003e\n          Use a known seed to generate the readable name for repeatability [env:\n          READABLE_NAME_GENERATOR_INITIAL_SEED=]\n  -c, --completion-shell \u003cCOMPLETION_SHELL\u003e\n          Generate completion for your shell [env: COMPLETION_SHELL=] [possible values: bash,\n          elvish, fish, powershell, zsh]\n  -h, --help\n          Print help\n  -V, --version\n          Print version\n```\n\n### Docker\n\nWe also have a docker image\n\n``` shell,skip()\ndocker run --rm -it ghcr.io/purplebooth/readable-name-generator:latest -i 1\n```\n\n``` shell,skip()\nflexible_briseglace\n```\n\n## Installing\n\nDownload the [latest\nrelease](https://codeberg.org/PurpleBooth/readable-name-generator/releases)\nand run it. I install it with homebrew. Or you could use docker.\n\n### Binaries\n\nBinaries for Windows, Linux and MacOS are available on the [releases\npage](https://codeberg.org/PurpleBooth/readable-name-generator/releases/latest)\n\n### Packages\n\nPackages are available for various platforms, including Debian, Arch Linux, RPM-based distributions, Alpine, and Docker.\n\nYou can access them on the [packages page](https://codeberg.org/PurpleBooth/readable-name-generator/packages).\n\nAdditionally, a Homebrew repository is provided:\n\n``` shell,skip()\nbrew install PurpleBooth/repo/readable-name-generator\n```\n\n## Development\n\n### Testing\n\nTo run the tests, run\n\n``` shell,skip()\njust test\n```\n\nTo run the end-to-end tests, run\n\n``` shell,skip()\njust specdown\n```\n\n### Automatic Code Formatting\n\nTo automatically tidy up the code in whatever way possible run\n\n``` shell,skip()\njust fmt\n```\n\n### Building docker\n\nWe have a docker container\n\n``` shell,skip()\ndocker build -t \"codeberg.org/purplebooth/readable-name-generator:latest\"\ndocker run --rm -it codeberg.org/purplebooth/readable-name-generator:latest -i 1\n```\n\n``` shell,skip()\nflexible_briseglace\n```\n\n## License\n\n[CC0 1.0 Universal](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPurpleBooth%2Freadable-name-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPurpleBooth%2Freadable-name-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPurpleBooth%2Freadable-name-generator/lists"}