Summary
The repository README explicitly states that it is for AWS CLI v1 and directs readers to the v2 branch for AWS CLI v2 information. Because the repository itself is named aws-cli, this can be easy to misinterpret on first visit and may leave users unsure whether they are in the right place. The README also notes that AWS CLI v1 will enter maintenance mode on July 15, 2026.
Current behavior
The README says, “This README is for the AWS CLI version 1,” and then points readers to the v2 branch if they are looking for version 2.
Expected behavior
The top of the repository should make the version distinction immediately obvious to new visitors, especially users arriving from search or GitHub’s repository page. Ideally, the README should reduce any chance of readers assuming this is the primary documentation for AWS CLI v2.
Why this matters
AWS CLI v1 is in a long-term support / maintenance transition, and the README already advises users to migrate to AWS CLI v2. A clearer versioning notice would help prevent confusion for new users, returning users, and anyone landing on the repository without prior context.
Suggested improvement
I would recommend adding a more prominent banner near the top of the README, for example:
AWS CLI v1 repository
This repository contains the AWS CLI v1 codebase and documentation. If you are looking for AWS CLI v2, please use the v2 branch.
Optionally, the README could also include a short “Which version should I use?” note that explains:
- this repository is for v1,
- v2 lives in the v2 branch,
- v1 is approaching maintenance mode,
- new users should usually start with v2 unless they have a specific v1 requirement.
Additional Context
This is a documentation clarity issue rather than a functional bug. I am opening it because the current wording is technically correct, but it could be made much easier to understand for first-time visitors
Links
https://github.com/aws/aws-cli/edit/develop/README.rst
Summary
The repository README explicitly states that it is for AWS CLI v1 and directs readers to the v2 branch for AWS CLI v2 information. Because the repository itself is named
aws-cli, this can be easy to misinterpret on first visit and may leave users unsure whether they are in the right place. The README also notes that AWS CLI v1 will enter maintenance mode on July 15, 2026.Current behavior
The README says, “This README is for the AWS CLI version 1,” and then points readers to the v2 branch if they are looking for version 2.
Expected behavior
The top of the repository should make the version distinction immediately obvious to new visitors, especially users arriving from search or GitHub’s repository page. Ideally, the README should reduce any chance of readers assuming this is the primary documentation for AWS CLI v2.
Why this matters
AWS CLI v1 is in a long-term support / maintenance transition, and the README already advises users to migrate to AWS CLI v2. A clearer versioning notice would help prevent confusion for new users, returning users, and anyone landing on the repository without prior context.
Suggested improvement
I would recommend adding a more prominent banner near the top of the README, for example:
Optionally, the README could also include a short “Which version should I use?” note that explains:
Additional Context
This is a documentation clarity issue rather than a functional bug. I am opening it because the current wording is technically correct, but it could be made much easier to understand for first-time visitors
Links
https://github.com/aws/aws-cli/edit/develop/README.rst