abp icon indicating copy to clipboard operation
abp copied to clipboard

Improve CLI Help output format

Open ebicoglu opened this issue 5 months ago • 3 comments

1. Some command printouts with emoji ,but some don't ... make it standard and do not use emoji in the outputs

Image Image

2. When an invalid command is entered, show the related help command as a reference

Image

3. Delete the following text, no need anymore!

Image

4. Indents are not clear

abp help new commands write the following output but the indents are not very good aligned, we can use a different formatting to show the related categories Image

maybe we can use an output like this -> example-cli-output.zip. extract the zip file and run the example-cli-output.bat to see the output

Image

ebicoglu avatar Aug 19 '25 07:08 ebicoglu

You can refer to this resource for a standardized CLI experience: https://bettercli.org/design/cli-help-page/

enisn avatar Aug 19 '25 07:08 enisn

maybe we can use an output like this -> example-cli-output.zip. extract the zip file and run the example-cli-output.bat to see the output

I disagree with the output. We don't need to explain all the templates in this help text. We can list only template names that can be used as a parameter. Detailed template help can be integrated into a specific template help command, such as abp new microservice --help. This will make the current help much clearer, and the template‑specific detailed explanation will be presented only for the selected template, avoiding confusion

Also community suggests Pager for that much long contents.

enisn avatar Aug 19 '25 07:08 enisn

How it should look like:

example-cli-output-modified.zip

Image

enisn avatar Aug 19 '25 07:08 enisn