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

Improve simple --help output #3861

Closed
pde opened this issue Dec 6, 2016 · 2 comments
Closed

Improve simple --help output #3861

pde opened this issue Dec 6, 2016 · 2 comments

Comments

@pde
Copy link
Member

pde commented Dec 6, 2016

Brainstorming about verbs, we decided to improve the top level output of cerbot -h:

certbot --help

  certbot [SUBCOMMAND] [options] [-d domain] [-d domain] ...

Certbot can obtain and install HTTPS/TLS/SSL certificates.  By default,
it will attempt to use a webserver both for obtaining and installing the
cert. The most common SUBCOMMANDS and flags are:
    
obtain, install, and renew certificates:
  (default) run       Obtain & install a cert in your current webserver
  certonly             Obtain or renew a cert, but do not install it
  renew                Renew all previously obtained certs that are near expiry

--apache          Use the Apache plugin for authentication & installation
--standalone      Run a standalone webserver for authentication
--nginx           Use the Nginx plugin for authentication & installation
--webroot         Place files in a server's webroot folder for authentication
--manual          Obtain certs interactively, or using shell script hoooks
 -n               Run non-interactively

manage certificates:    
  certificates         Display information about certs configured with Certbot
  manage             Interactively manage your certificates
  rename              Update a certificate's name 
  revoke               Revoke a previously obtained certificate
    
manage your account with Let's Encrypt:
  register           Create an account
  account           Interactively manage your account

More detailed help:

  -h, --help [topic]    print this message, or detailed help on a topic;
                              the available topics are:

   all, automation, commands, paths, security, testing, or any of the subcommands or
   plugins (certonly, renew, install, register, nginx, apache, standalone,
   webroot, script, etc.)
@pde pde added this to the 0.10.0 milestone Dec 6, 2016
@pde pde self-assigned this Dec 6, 2016
@pde pde added the has pr label Dec 10, 2016
@pde
Copy link
Member Author

pde commented Dec 14, 2016

Closed by: #3863

@pde pde closed this as completed Dec 14, 2016
@pde
Copy link
Member Author

pde commented Dec 14, 2016

Closed by: #3883.

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

1 participant