logoalt Hacker News

OptionOfTlast Sunday at 5:16 PM5 repliesview on HN

Equally I don't like how many instructions and scripts everywhere use shorthands.

Sometimes you see curl -sSLfO. Please, use the long form. It makes life easier for everybody. It makes it easier to verify, and to look up. Finding --silent in curl's docs is easier than reading through every occurrence of -s.

   curl --silent --show-error --location --fail --remote name https://example.com/script.sh
Obligatory xkcd: https://xkcd.com/1168/

Replies

Terr_last Sunday at 9:13 PM

For a small flight of fancy, imagine if each program had a --for-docs argument, which causes it to simply spit out the canonical long-form version equivalent to whatever else it has been called with.

show 1 reply
yjftsjthsd-hlast Monday at 8:07 AM

> Finding --silent in curl's docs is easier than reading through every occurrence of -s.

Dumb trick: Search prefixed with 2 spaces.

  man curl
  /  -s
Yields exactly one hit on my machine. In the general case, you may have to try one and two spaces.
ndsipa_pomulast Sunday at 5:34 PM

Absolutely agree.

The shorthands are for when typing it at a console and the long form versions should be used in scripts.

lionkorlast Monday at 12:06 PM

Aren't there tools for which the short flags are standardized (e.g. POSIX) but the long flags aren't?

scramelast Monday at 12:08 AM

agreed. i get if you're great at cli usage or have your own scripts, but if you're publishing for general use, it should be long form. that includes even utility scripts for a small team.

also, putting it out long-form you might catch some things you do out of habit, rather than what's necessary for the job.

show 1 reply