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

Adding --help for better user experience #40

Open
ranfdev opened this issue Nov 12, 2020 · 3 comments
Open

Adding --help for better user experience #40

ranfdev opened this issue Nov 12, 2020 · 3 comments

Comments

@ranfdev
Copy link

ranfdev commented Nov 12, 2020

Currently there isn't any way to see the available commands.
I can't do onlykey --help.

The python module argparse (which I think is included by default in python), can simplify argument parsing and adds a nicer user experience, by automatically creating an help section.

Are you interested in adding an --help flag?
Can i do a pull request introducing argparse and adding the --help flag?

https://docs.python.org/3/library/argparse.html

@ranfdev ranfdev changed the title Using argparse for better user experience Adding --help for better user experience Nov 12, 2020
@onlykey
Copy link
Contributor

onlykey commented Nov 13, 2020

@ranfdev The --help flag was added here

elif sys.argv[1] == '--help':

but right now its only printing this:

See available command options here https://docs.crp.to/command-line.html

So you still have to go to the docs to see command options

@altsalt
Copy link

altsalt commented Aug 15, 2021

@ranfdev seems to have put in the initial effort to resolve this. May I ask what is still needed? Being able to query the commands without having a browser open would be appreciated.

@onlykey
Copy link
Contributor

onlykey commented Aug 16, 2021

Currently, in order to ensure the most up-to-date command options we have those available in our docs at the link provided. The PR for argparse had some issues working with some of the commands so that remains open until we are able to resolve argparse issues.

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

No branches or pull requests

3 participants