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

UX: Make the CLI easier to use 😋 #2124

Open
zFernand0 opened this issue Apr 25, 2024 · 2 comments
Open

UX: Make the CLI easier to use 😋 #2124

zFernand0 opened this issue Apr 25, 2024 · 2 comments
Labels
enhancement New feature or request priority-low Legit issue but cosmetic or nice-to-have UX User Experience Design Issues

Comments

@zFernand0
Copy link
Member

Is your feature or enhancement request related to a problem or limitation? Please describe

Users may find it hard to find the right syntax for the commands that they want to issue.

> zowe help # this fails because it doesn't have the `--` in front
> zowe files listds SYS1.PARMLIB # this fails because of the invalid `listds` key
> zowe files list ds SYS1.PARMLIB -ru false # this fails because `-ru` gets split into `-r true -u false` 

Describe your enhancement idea

After some discussion with a few team members, we could:

  1. Provide an interactive help approach (like manpage) when running zowe help
  2. Provide an interactive approach to the commands (with tab auto-completion)
  3. Provide examples under each option in the help and web-help, see picture below

Describe alternatives you've considered

N/A

Provide any additional context

Hopefully this helps visualize the enhancement idea about adding examples closer to the options (instead of at the bottom)
image

@zFernand0 zFernand0 added enhancement New feature or request UX User Experience Design Issues new The issue wasn't triaged yet labels Apr 25, 2024
Copy link

Thank you for raising this enhancement request.
The community has 90 days to vote on it.
If the enhancement receives at least 5 upvotes, it is added to our development backlog.
If it receives fewer votes, the issue is closed.

@t1m0thyj
Copy link
Member

$ zowe help
Command Error:
Command failed due to improper syntax
Unknown group: help
Did you mean: zftp?

Command entered: "help"
Use "zowe --help" to view groups, commands, and options.

Perhaps we could mention web help more prominently since it offers an easier way to browse example commands?
Use "zowe --help" or "zowe --help-web" to view groups, commands and options."

@JTonda JTonda added priority-low Legit issue but cosmetic or nice-to-have and removed new The issue wasn't triaged yet labels Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request priority-low Legit issue but cosmetic or nice-to-have UX User Experience Design Issues
Projects
Status: Low Priority
Development

No branches or pull requests

3 participants