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

command line help needs to match command line design #285

Closed
pde opened this issue Mar 17, 2015 · 3 comments
Closed

command line help needs to match command line design #285

pde opened this issue Mar 17, 2015 · 3 comments
Assignees
Milestone

Comments

@pde
Copy link
Member

pde commented Mar 17, 2015

Over in this issue we have a design for the major verbs and different subcategories of options that the client needs to expose in order to be as swiftly comprehensible as possible to users.

Currently the client, if invoked with --help, prints this:

usage: letsencrypt [-h] [-d DOMAIN [DOMAIN ...]] [-s SERVER] [-k AUTHKEY]
                   [-B N] [-R] [--revoke-certificate REV_CERT]
                   [--revoke-key REV_KEY] [-b N] [-v] [-r] [--no-confirm] [-e]
                   [-t] [--config-dir CONFIG_DIR] [--work-dir WORK_DIR]
                   [--backup-dir BACKUP_DIR] [--key-dir KEY_DIR]
                   [--cert-dir CERT_DIR] [--le-vhost-ext LE_VHOST_EXT]
                   [--cert-path CERT_PATH] [--chain-path CHAIN_PATH]
                   [--apache-server-root APACHE_SERVER_ROOT]
                   [--apache-mod-ssl-conf APACHE_MOD_SSL_CONF]
                   [--apache-ctl APACHE_CTL] [--apache-enmod APACHE_ENMOD]
                   [--apache-init-script APACHE_INIT_SCRIPT]
                   [-c FILE [FILE ...]] [--export-conf-file [FILE]]

followed by a very long and seemingly randomly-ordered list of options.

It should list the major command verbs at the top, with [options] for each one, not an exhaustive list. Then enumerate the most important options, and save the subcategories of options for if the user runs with -h -h, or asks for help about options for a specific verb.

@pde pde added this to the 1.0 for launch milestone Mar 17, 2015
@pde
Copy link
Member Author

pde commented Mar 17, 2015

Happy to provide a mockup of what this should look like if more clarity is needed : )

@jdkasten
Copy link
Contributor

I think we should remove the top "usage" printout and leave only the detailed descriptions. The "usage section" is useless, but since this is autogenerated by ConfArgParse, I haven't looked into whether or not this is easily achieved.

I personally haven't spent any time organizing the list yet, though I think it can be greatly improved with sections.

There is also some cleanup/refactoring required for cert-path/cert-dir and key-path/key-dir. (Cert/Key named output). (These options were poorly transferred back from when we had a CONFIG.py file.)

@kuba
Copy link
Contributor

kuba commented May 2, 2015

I'm working on that in https://github.com/kuba/lets-encrypt-preview/tree/cli

This looks like a duplicate of #136. Can we close one?

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

No branches or pull requests

4 participants