Update README zsh completion for bundled installer#10327
Open
adev-code wants to merge 2 commits into
Open
Conversation
The README's zsh section points to bin/aws_zsh_completer.sh, which is shipped via Package Manager installs (e.g. pip) but not by the bundled installer (zip/pkg). Bundled-installer users following the README hit "No such file or directory" when sourcing it. Keep the existing pip instructions and add a parallel block for bundled installs using the bashcompinit + complete -C approach documented in the AWS CLI User Guide. Both methods now coexist without removing the legacy path that pip users still rely on. Fixes aws#8957
hssyoo
reviewed
May 20, 2026
Comment on lines
+90
to
+92
| For zsh please refer to ``bin/aws_zsh_completer.sh``. Source that file, e.g. | ||
| from your ``~/.zshrc``, and make sure you run ``compinit`` before:: | ||
| For zsh (Package Manager, e.g. pip installs) please refer to | ||
| ``bin/aws_zsh_completer.sh``. Source that file, e.g. from your | ||
| ``~/.zshrc``, and make sure you run ``compinit`` before:: |
Contributor
There was a problem hiding this comment.
Source builds should still produce an aws_completer exe:
$ pip install -e .
$ ls .venv/bin | rg "aws"
aws
aws_bash_completer
aws_completer
aws_zsh_completer.sh
aws.cmd
We should be good to just recommend the same set of instructions. Can you confirm?
Contributor
Author
There was a problem hiding this comment.
yes thank you, I confirmed it:
$ ls /tmp/pip-readme-test/bin/ | grep aws
aws
aws.cmd
aws_bash_completer
aws_completer
aws_zsh_completer.sh
Will update the PR to use one set of instructions.
Contributor
There was a problem hiding this comment.
Sorry, I meant can you confirm that the autocomplete functionality works when following the aws_completer instructions after building via pip?
Both pip and bundled installs ship aws_completer, so a single set of instructions covers both methods. Replace the legacy aws_zsh_completer.sh block with bashcompinit + complete -C aws_completer as documented in the AWS CLI User Guide: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-completion.html Fixes aws#8957
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #8957. The README's zsh instructions point to
bin/aws_zsh_completer.sh, which ships with Package Managerinstalls (e.g. pip) but not with the bundled installer (zip/pkg).
Bundled-installer users hit "No such file or directory".
Change
Scope the existing zsh block to Package Manager installs and add a
parallel block for the bundled installer using
bashcompinit+complete -C aws_completer aws.Reference
Configuring command completion in the AWS CLI