search

adobe / aio-cli

Adobe I/O Extensible CLI
https://www.adobe.io
Apache License 2.0
77 stars 33 forks source link

readme docs: confusing help for `aio config` #627

Open shazron opened 2 months ago

shazron commented 2 months ago

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:password@example.com/ aio config -e HTTP_PROXY https://user:password@example.com/

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.

aiojbot commented 2 months ago

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

shazron commented 2 months ago

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

aiojbot commented 2 months ago

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