[ 
https://issues.apache.org/jira/browse/SCB-1701?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17006572#comment-17006572
 ] 

Willem Jiang commented on SCB-1701:
-----------------------------------

{code}
usage: cli.sh <command> [<args>]

The most commonly used cli.sh commands are:
    cc                   Check compatibility for two OpenAPI v3 spec yamls, 
right one should be semantically compatible with left one(abbr for 
checkcompatibility)
    checkcompatibility   Check compatibility for two OpenAPI v3 spec yamls, 
right one should be semantically compatible with left one
    checkstyle           Check style for OpenAPI v3 spec yaml
    codegenerate         Generate multiple models of microservice project by 
OpenAPI specification file
    cs                   Check style for OpenAPI v3 spec yaml(abbr for 
checkstyle)
    docgenerate          Generate document by OpenAPI specification file
    help                 Display help information
{code}
 It could be better
{code}
usage: cli.sh <command> [<args>]

The most commonly used cli.sh commands are:
    cc | checkcompatibility Check compatibility for two OpenAPI v3 spec yamls, 
right one should be semantically compatible with left one
    cs | checkstyle           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 information
{code}

> Clean up the help document for CLI of toolkit
> ---------------------------------------------
>
>                 Key: SCB-1701
>                 URL: https://issues.apache.org/jira/browse/SCB-1701
>             Project: Apache ServiceComb
>          Issue Type: Improvement
>          Components: toolkit
>            Reporter: Willem Jiang
>            Priority: Minor
>
> It could be more clear if we can put the short version of parameter and long 
> version of parameter together.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to