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

readme docs: confusing help for aio config #627

Open
shazron opened this issue Aug 5, 2024 · 3 comments
Open

readme docs: confusing help for aio config #627

shazron opened this issue Aug 5, 2024 · 3 comments
Labels
bug Something isn't working

Comments

@shazron
Copy link
Member

shazron commented Aug 5, 2024

From a user:

Proxy support section on this page https://github.com/adobe/aio-cli?tab=readme-ov-file#proxy-support says set environment variable (refer image) and same page has a section dedicated to setting up environment variable (refer image). That is causing confusion.

I was trying to setup environment variable as following which are both wrong.
aio config -e HTTP_PROXY=https://user:[email protected]/
aio config -e HTTP_PROXY https://user:[email protected]/

image_720
image_720-1

Explanation

aio config is actually an alias for aio config list, but it also lists get, set, edit etc in its help. Users are confused here since aio config also lists the whole help for aio config (and its subcommands), as well as it being the alias for aio config list and showing the flags for that.

@shazron shazron added the enhancement New feature or request label Aug 5, 2024
@shazron shazron changed the title readme docs: confusing --env flag readme docs: confusing help for aio config Aug 5, 2024
@aiojbot
Copy link

aiojbot commented Aug 5, 2024

JIRA issue created: https://jira.corp.adobe.com/browse/ACNA-3110

@shazron
Copy link
Member Author

shazron commented Aug 5, 2024

https://github.com/adobe/aio-cli-plugin-config/blame/6cc403bc59bfca43ba943bc1e1728bf4ab3c4f79/src/commands/config/index.js#L15

The command is doing something weird, in that it inherits from another command. It shouldn't do so, in this case it is essentially just the list command (not an alias. the alias here is implicit).
It should do something like this instead: https://github.com/adobe/aio-cli-plugin-app/blob/master/src/commands/app/index.js

@shazron shazron added bug Something isn't working and removed enhancement New feature or request labels Aug 5, 2024
@aiojbot
Copy link

aiojbot commented Aug 5, 2024

JIRA issue created: https://jira.corp.adobe.com/browse/ACNA-3111

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants