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 cli output #210

Open
hnicke opened this issue Nov 15, 2017 · 0 comments
Open

Improve cli output #210

hnicke opened this issue Nov 15, 2017 · 0 comments
Assignees

Comments

@hnicke
Copy link
Contributor

hnicke commented Nov 15, 2017

I'd like to start a discussion with focus on the output of the CLI.

I'll use the imperative form for convenience, please don't be offended.

When i write toscana <something> i mean: the output produced by this command.

  • e.g. toscana: Get rid of that green, bold heading. The color causes eye cancer. Its not normal for a command line interface to print its name in bold, colored letters on top of the command all the time. its rather annoying. Get rid of the heading, in all commands.
  • while we're talking about colors: the available options are super boring: most of the time --verbose and --moreverbose. But ironically they scream at me in color, while the rest is white. This does not help to focus on the essentials.
  • e.g. toscana d: this command is invalid. And every invalid command produces a boilerplate of output. This is just noise. Noone needs it. Print a short usage message, not more.
  • e.g. toscana d: if i enter an invalid command, i don't want the screen to scream at me in bold letters. thats rather distracting. i lose focus from my last, entered command, and i'm immediately lost. Actually, I'd remove the bold effect at all, for better readability (motto: what you say is important for me, is not important for me)
  • toscana csar list:

List of CSARs:
Name: simple-task

  • This first line List of CSARs: is completely redundant. Oh, shut up, program: Of course you're going to tell me the list of csars. Pure noise. Shall be removed.

  • Neither do I like the second line Name: simple-task. I like simple-task. of course its the name.

    • why is this so important for me? Well, ever tried to script command line tools? Filter -> Pipe -> Filter -> Pipe, and everything is text. Output of a command line interface is valuable data. Try not to mimic a GUI. Every developer will curse you, because tedious sed/awk acrobatic is required to get the real information out of your cli.
  • toscana csar upload -f <my.csar>:

Upload of CSAR Archive was successful!

  • don't bother the user with reports of successful doing something. Only print message if program fails doing something. This is considered noise and shall be removed. Shall also get removed for all similar cases.
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

2 participants