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 documentation show case while doing completion #3444

Open
remyleone opened this issue Oct 20, 2023 · 0 comments
Open

Improve documentation show case while doing completion #3444

remyleone opened this issue Oct 20, 2023 · 0 comments
Assignees
Labels
autocomplete documentation enhancement priority:medium Improvements that are not the main priority

Comments

@remyleone
Copy link
Member

Description

At the moment when I try to complete in ZSH:

$ scw
\              account        apple-silicon  baremetal      cockpit        container      document-db    fip            help           info           instance       ipfs           lb             mnq            rdb            registry       shell          version        vpc-gw                                                                                                                                                                                                                                      
--             alias          autocomplete   billing        config         dns            feedback       function       iam            init           iot            k8s            marketplace    object         redis          secret         tem            vpc            webhosting  

let's compare that with other well known CLI such as kubectl in ZSH:

Capture d’écran 2023-10-20 à 17 20 48

And in fish:

Capture d’écran 2023-10-20 à 17 20 22

How I imagine scw could expose this functionality

When I type a TAB, in the suggestions I would get the documentation string. It might not be possible in all shells but it would help in modern and dev focused shells such as ZSH and fish

References

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autocomplete documentation enhancement priority:medium Improvements that are not the main priority
Projects
None yet
Development

No branches or pull requests

2 participants