thought/write-posix-shell.html
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
write posix shell 2023-03-10 /\ {.-} ;_.-'\ { _.}_ \.-' / `, \ | / \ | ,/ [0] \|_/ what is shell? most people in tech are familiar with shell scripts. but shell is a language! ... shit. actually. wait, let me rephrase- most people _use_ shell. most people _avoid_ shell. but mostly most people _hate_ shell. but should they? why do people hate shell? arcane syntax shell's syntax can feel cumbersome and cryptic because it was invented around the time people thought lawn darts were a good idea. confusing error handling in python there's try/except. in golang, errors are values. in shell, errors sorta just happen in insane ways. hard to maintain when shell grows beyond a few hundred lines or so, it becomes impossible to maintain. unique and weird since shell has no canonical format, shell scripts can look wildly different depending on the author, which furthers confusion. perception in the tech industry, people often look down on shell scripts as tech debt / lame, devs are often incentiviced to use hotter, more exciting things. so why use shell at all? simply: because shell is an insanely productive language. in fact, i believe that shell is the *most* productive language. in terms of time + brainpower spent to produce a result, shell can do in 10 seconds what would take much longer in any other language, because shell is optimized for speed, instant feedback, and is enhanced by many years of easily searchable knowledge. shell is also ubiquitous and accessible almost anywhere you need it. people often think that i work extremely quickly. they think that i must have Exceptional Skills my friends, i have no secret - i am dumb as hell. but i do know a little bit of shell. [1] .----. @ @ / .-"-.`. \v/ | | '\ \ \_/ ) ,-\ `-.' /.' / .................'---`----'----'______________*,___'_ bash me in the head like human languages, shell has many dialects. there's the common bash and zsh. let's see. there's also ksh. oh, and dash. and fish. and csh. mrsh. tcsh. pdksh. the list of shell dialects goes on and on forever, like a big long slimy snail trail. each shell dialect has varying levels of compatability with the others. for example, imagine writing a bash shell script only to later realize that it won't run inside of your alpine container, because alpine uses dash. imagine writing a shell script on macos, only to realize that it isn't compatible with linux. when people write shell, they will often say things like "i'm writing bash" or "i'm bash scripting" people say "bash" because bash is the most common shell dialect. to be clear: if you write shell and use some bash features, you're writing shell in the bash dialect. if you happen to not use any bash features, then you're writing plain old shell. the reason i'm being pedantic about dialects is because i believe that most people should only learn and write a single dialect of shell: posix shell this opinion is not very widespread, but i think that it should be. let me explain *eternal sunshine of the posix shell* describing posix shell is simple. it is shell written in accordance with the posix specification. the bad news is that the posix specification is documented on the worst website i've ever seen[2], which i believe is a twisted conspiracy to make posix shell less popular. the good news is that if you write posix shell, there are huge benefits. posix shell is compatible: it'll run on debian, ubuntu, on openbsd, in an alpine container, on illumos! arch! even horrible old AIX! posix shell is defined: the posix spec fully describes how shell should work. it defines every command, every flag, and every builtin function. it defines how loops work, how case statements ought to look, yadda yadda. posix shell is pretty small: if you enjoy reading technical specifications for fun (aka: if you are a massochist), you might read through the posix spec - it'd only take a day or two. or, you might just read the parts of it that apply to the problems you're solving, and piece it together as you go. this feels bad: running arcane shell commands copy&pasted from stackoverflow, having them work, and being like "uhhhh wut" and moving on because "shell is such a weird little guy" this feels good: running posix shell commands that you reference directly from the specification, knowing that they'll simply work everywhere on everything for eternity. posix shell is eternal: imagine posix shell as the "standard library of shell" the concrete foundation on which you stand. posix shell was first defined in 1992, and has remained largely the same since. it is an important language that has lasted 30 years, and is very likely to last 30 more. /------------------------------\ | | | omg! | | posix shell is amazing! | | i wanna use it everywhere! | | i wanna go use it RIGHT NOW! | \------------------------------/* * * 🤔 <-- you slow down there you son of a gun!! yes, posix shell is amazing, but it's also very constraining. consider this sentence: "arrays do not exist in posix shell" ... "NOOO!" you shout, because you like data structures a LOT "now THAT'S a good reason to use bash! bash supports arrays!" absolutely not! i believe that you should use shell if your problem is: - small and scoped (~200 lines of shell or less) - unlikely to increase in size and scope as time goes on - not very complex if you find yourself desiring arrays, good error handling, static typing, structs, etc, then your problem should be solved using a different language, not shell. in this way, posix shell offers you a "sniff test" if something sucks to implement in posix shell, you probably shouldn't implement it in shell at all. when should i use shell? in short; when the problem you're solving is small, well defined, and unlikely to change, consider shell. when the problem you're solving involves linux, text processing, or managing files, consider shell. here are a bunch of examples of great little shell programs: - mass rename files and make them consistent (*.erb.html -> *.html) - make a take-my-estrogen alarm clock (perhaps your laptop would beep) - run a command when any .go files change - find all files that end in .kfx and delete them forever - run commands on a bunch of remote systems at once - count the number of occurrences of the word "fuck" across your projects, and sort the results - make a shell program that backs your raspberry pi up to an external hard drive - submit JSON data to an endpoint on a schedule - check a git repo for updates and then run commands (this is how i deploy j3s.sh!) - attempt to predict rss feed endpoints and print any that exist (my friend begriffs[3] and i wrote shell that does this) all of the above examples would take between 10 seconds and 5 minutes to implement in the hands of an experienced shell person. that person could be you!! ✨ posix shell inspo ✨ dylan araps is the person who first inspired me to dig into posix shell, and his projects[4] are absolutely worth a browse. drew devault often promotes posix shell, and has used posix shell to write a git client called shit[5] check out pa[6], a posix shell password manager that i made. check out my dotfiles[7], which contain a ton of little posix shell scripts that i use for all sorts of things here's a cool arch wiki entry[8] on shells, check out the posix section. shellcheck[9] is an amazing tool that can check your shell for posix compatability issues & many other things. i use it every time i write more than a few dozen lines of shell. shfmt[10] is like gofmt, but for shell. it supports posix shell as well! :D posix shell is fun, sloppy, powerful, portable, and eternal. wield it with caution, dear friend. but enjoy yourself. NOW GET OUT THERE AND WRITE SOME POSIX SHELL, GOD DAMNIT! ALL HAIL POSIX SHELL! ALL SNAIL POSIX SHELL! __,._ / _ \ | o \ \ oo \___/ .|__|| __,..="^ . , " , \ ............<._________________=/*___.__*___'___all snail!?____ NOW GET OUT OF HERE CUTIE! -jes => refs [0]: https://archive.ph/KLpzo [1]: ascii snail by Hayley Jane Wakenshaw [2]: https://archive.ph/higTn sidenote: if anyone out there wants to make a posix shell website that doesn't suck absolute ass, let me know. [3]: https://begriffs.com [4]: https://github.com/dylanaraps [5]: https://git.sr.ht/~sircmpwn/shit [6]: https://github.com/biox/pa [7]: https://git.j3s.sh/dotfiles/tree/main/bin [8]: https://wiki.archlinux.org/title/command-line_shell [9]: https://www.shellcheck.net [10]: https://github.com/mvdan/sh