Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User-friendly CLI #25

Open
c089 opened this issue Apr 4, 2015 · 1 comment
Open

User-friendly CLI #25

c089 opened this issue Apr 4, 2015 · 1 comment

Comments

@c089
Copy link
Contributor

c089 commented Apr 4, 2015

To avoid confusing users we should improve the way command line arguments are parsed. At least it should:

  • show usage information when invoked without arguments, or with -h or --help
  • show a helpful error message if any of the arguments are missing or of the wrong type

If this becomes too cumbersome to implement with the very simple minimist engine, it might be good consider using a full-featured parsing engine such as yargs for this.

@c089 c089 changed the title Implement user-friendly CLI User-friendly CLI Apr 4, 2015
@bmpvieira bmpvieira removed the ready label Apr 7, 2017
@bmpvieira bmpvieira moved this from Next to In Progress in Bionode Project Board Apr 21, 2017
@bmpvieira bmpvieira self-assigned this Apr 21, 2017
@bmpvieira bmpvieira moved this from In Progress to Next in Bionode Project Board Apr 22, 2017
@bmpvieira bmpvieira removed their assignment Apr 22, 2017
@yochannah
Copy link

Apologies for completely poking my nose in out of the blue - I was browsing tickets, saw this one and thought this might be of interest since it's relevant... https://gigascience.biomedcentral.com/articles/10.1186/2047-217X-2-15
"Ten recommendations for creating usable bioinformatics command line software"

:) hope the link is of some use!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

3 participants