guardian / ssm-scala

ssh replacement: CLI program that wraps SSM's EC2 Run Command
Apache License 2.0
21 stars 0 forks source link

Add `--help` option #378

Closed davidfurey closed 8 months ago

davidfurey commented 8 months ago

What does this change?

scopt has a special option with a predefined action called help("help"). When help("help") is defined, parser will print out a short error message when it fails instead of printing the entire usage text.

This is useful, because the existing behaviour is to display the short error message and then the long usage text, which masks the helpful error message.

What is the value of this?

Less scrolling required to see the helpful error message when you make a mistake running ssm

philmcmahon commented 8 months ago

@davidfurey I'm still trying to sort out my last release https://github.com/guardian/homebrew-devtools/pull/97 - happy to do the release for this change and release them together if it would be helpful.

davidfurey commented 8 months ago

Sounds good to me, thanks!

Did you mean to close this PR?

philmcmahon commented 8 months ago

@davidfurey oh no! No I didn't, sorry