Writing good CLI apps - Programming On Unix

Users browsing this thread: 1 Guest(s)
mrnd
Members
Few thoughts:

Quote:First of all, it complexify you program, as it forces you to handle edge-cases, for example if you don't make use of long options, or subcommands.

This is basically developer experience vs. user experience. It's true that you probably should not use all of these for simple scripts, but on the other hand, simple scripts don't need to be "great CLI apps". Great software requires great user experience, and handling these common cases is not that complex.

Quote:Moreover, it's said that the help text should display common usage example, and detail the options.
This is noisy and unhelpful

This is completely subjective, but I'm fairly certain that most users greatly appreciate writing out at least the most common use case and few options.

Quote:Manpages are the only reliable documentation you can get offline.

Yes. Luckily --help and man pages are not mutually exclusive. Both is best.

On error messages I mostly agree, though you should probably consider greater detail on more complex cases.


Messages In This Thread
Writing good CLI apps - by z3bra - 12-10-2018, 01:52 PM
RE: Writing good CLI apps - by jkl - 12-10-2018, 03:11 PM
RE: Writing good CLI apps - by z3bra - 12-10-2018, 04:38 PM
RE: Writing good CLI apps - by mrnd - 12-10-2018, 05:36 PM
RE: Writing good CLI apps - by z3bra - 12-10-2018, 07:12 PM
RE: Writing good CLI apps - by venam - 13-10-2018, 03:14 AM