readable-name-generator 4.3.15

Generate a readable name for throwaway infrastructure
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

# 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")
flexible_briseglace
```

### Changing the separator

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

``` shell,verify(script_name="seperator")
flexible###briseglace
```

### Randomized Suffix

You can further reduce the chance of a collision by suffixing a random number

``` shell,script(name="seperator")
readable-name-generator --initial-seed 1 --suffix
```

``` shell,verify(script_name="seperator")
vivacious_demibold8
```

### 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 <SEPARATOR>
          The separator to use [env: READABLE_NAME_GENERATOR_SEPARATOR=] [default: _]
  -n, --suffix
          Suffix a random number to prevent collisions [env: READABLE_NAME_GENERATOR_SUFFIX=]
  -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

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

``` shell,skip()
flexible_briseglace
```

## Installing

Download the [latest
release](https://codeberg.org/PurpleBooth/readable-name-generator/releases)
and run it. I install it with homebrew. Or you could use docker.

### Binaries

Binaries for Windows, Linux and MacOS are available on the [releases
page](https://codeberg.org/PurpleBooth/readable-name-generator/releases/latest)

### Packages

Packages are available for various platforms, including Debian, Arch Linux, RPM-based distributions, Alpine, and Docker.

You can access them on the [packages page](https://codeberg.org/PurpleBooth/readable-name-generator/packages).

Additionally, a Homebrew repository is provided:

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

## 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 "codeberg.org/purplebooth/readable-name-generator:latest"
docker run --rm -it codeberg.org/purplebooth/readable-name-generator:latest -i 1
```

``` shell,skip()
flexible_briseglace
```

## License

[CC0 1.0 Universal](LICENSE.md).