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

Help does not display env name when configured for a parameter #981

Open
GMZwinge opened this issue Oct 7, 2021 · 2 comments
Open

Help does not display env name when configured for a parameter #981

GMZwinge opened this issue Oct 7, 2021 · 2 comments
Labels
--help output Related to --help output enhancement New feature or request good first issue Good for newcomers help wanted Accepting PRs

Comments

@GMZwinge
Copy link

GMZwinge commented Oct 7, 2021

Do you want to request a feature or report a bug?

Feature

Similar to how flags default are displayed in the help for a command, the help could also display the name of the environment variable when configured for a flag.

What is the current behavior?

bin\run <command> --help displays for each flags the default if configured, eg:

--my-flag=my-flag    [default: my-default] Flag for ...

To find out the environment variable name that can be used instead of a flag, one must look at the code, or add manually the variable name to the flag's help.

What is the expected behavior?

Help could include the name of the environment variable, eg something like this:

--my-flag=my-flag    [default: my-default, env: MY_FLAG] Flag for ...

@whalemare
Copy link

Bump, really useful feature

Copy link

git2gus bot commented Mar 1, 2024

This issue has been linked to a new work item: W-15161040

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
--help output Related to --help output enhancement New feature or request good first issue Good for newcomers help wanted Accepting PRs
Projects
None yet
Development

No branches or pull requests

3 participants