adobe / adobe/aio-cli

readme docs: confusing help for `aio config`

Open
#627 3 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
JavaScript
Stars
95
Forks
45
PR merge metrics
No merged PRs in 30d

Description

## 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](https://github.com/user-attachments/assets/6e5aabe6-6bc3-4104-a1a6-12a25bfab604)
![image_720-1](https://github.com/user-attachments/assets/b5f2d20e-f918-498f-adac-2636891095bb)

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

Contributor guide

Open the contributing guide

Research direction

Start with the Proxy support and environment-variable sections in the README, then inspect the `aio config` help entry point and its `list` alias. Clarify which command users should run and ensure the README and help output do not present conflicting guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.