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

feature: show environment variable names in usage #131

Open
voxeljorge opened this issue Sep 30, 2022 · 2 comments
Open

feature: show environment variable names in usage #131

voxeljorge opened this issue Sep 30, 2022 · 2 comments

Comments

@voxeljorge
Copy link

It would be handy to have some way to print environment variable names either in the -h usage or from some other help flag. This would help make it more obvious to someone running an application configured by aconfig what their config options are.

@cristaloleg
Copy link
Member

Hi, sounds useful. Any idea for the api?

Currently we have Walk method to iterate over all fields. Probably it should be replaced with something userfriendly or...I don't know.

@voxeljorge
Copy link
Author

Walk is useful for sure and enables someone to implement this themselves if necessary. I'm not sure what the best API would be, maybe an EnvUsage bool flag in the loader config? That flag could trigger environment usage information to get added to the usage printed via -h

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