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

Not clear how to use "list" subcommand, or what it effectively does #14

Closed
arunsathiya opened this issue Apr 5, 2023 · 1 comment
Closed

Comments

@arunsathiya
Copy link

It'd be helpful to describe how the "list" subcommand is used/what it actually does.

At this time, envio list --help says List all the environment variables in a profile or all the profiles which gives me the impression that it lists out all the environment variables associated with all profiles, but it actually does the following:

  • envio list alone results in Invalid number of arguments error, because the command expects a profile name, or the string profiles to list out all the profiles. This improvement is being explored in When using subcommand it's unclear how to list out profiles #2
  • envio list profileName or envio list profiles results in listing of environment variables associated with the particular profile (in this example, named profileName) or all profile names.

I think, overall, it'd be helpful to branch out list into two different commands; list-profiles to list all the profiles, and list-envvars profileName to list envvars associated with a profile name.

If it's decided to retain the current approach, it'd perhaps be helpful to explore improving the Arguments part of the --help output:

image

@humblepenguinn
Copy link
Collaborator

humblepenguinn commented Apr 5, 2023

The description provided by the envio list command, in my opinion, seems well explained to me.

which gives me the impression that it lists out all the environment variables associated with all profiles

It mentions it lists all the environment variables in a profile not all the environment variables associated with all profiles. So I do not quite understand how you came to this conclusion.

I also think that the current approach is better rather than breaking list into two entirely different sub commands.

But, yes, you are right it would be helpful to improve the arguments part of the --help output. I'm thinking of just scraping the help message that clap provides and overriding it with a custom one.

Thank you for your feedback! It helps out a lot

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants