apache / servicecomb-toolkit

Apache servicecomb
https://servicecomb.apache.org/
Apache License 2.0
437 stars 34 forks source link

SCB-1701 Clean up the help document for CLI of toolkit #76

Closed chanjarster closed 4 years ago

chanjarster commented 4 years ago

JIRA: https://issues.apache.org/jira/browse/SCB-1701

The help will looks like this:

usage: java -jar cli-0.2.0.jar <command> [<args>]The most commonly used java -jar cli-0.2.0.jar commands are:
    checkcompatibility   (Or cc for abbr). Check compatibility for two OpenAPI v3 spec yamls, right one should be semantically compatible with left one
    checkstyle           (Or cs for abbr). Check style for OpenAPI v3 spec yaml.
    codegenerate         Generate multiple models of microservice project by OpenAPI specification file
    docgenerate          Generate document by OpenAPI specification file
    help                 Display help informationSee 'java -jar cli-0.2.0.jar help <command>' for more information on a specific
command.
kakulisen commented 4 years ago

LGTM