core icon indicating copy to clipboard operation
core copied to clipboard

Help does not display env name when configured for a parameter

Open GMZwinge opened this issue 3 years ago • 2 comments

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 ...

GMZwinge avatar Oct 07 '21 21:10 GMZwinge

Bump, really useful feature

whalemare avatar Oct 08 '22 05:10 whalemare

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

git2gus[bot] avatar Mar 01 '24 19:03 git2gus[bot]