History

Marc Cornellà 6d143d42ea aws: document aws_change_access_key and fix README		2019-03-24 19:54:56 +01:00
..
README.md	aws: document aws_change_access_key and fix README	2019-03-24 19:54:56 +01:00
aws.plugin.zsh	aws: clean up aws_change_access_key function	2019-03-24 19:50:47 +01:00

README.md

aws

This plugin provides completion support for awscli and a few utilities to manage AWS profiles and display them in the prompt.

To use it, add aws to the plugins array in your zshrc file.

plugins=(... aws)

Plugin commands

asp [<profile>]: sets $AWS_PROFILE and $AWS_DEFAULT_PROFILE (legacy) to <profile>. It also sets $AWS_EB_PROFILE to <profile> for the Elastic Beanstalk CLI. Run asp without arguments to clear the profile.
agp: gets the current value of $AWS_PROFILE.
aws_change_access_key: changes the AWS access key of a profile.
aws_profiles: lists the available profiles in the $AWS_CONFIG_FILE (default: ~/.aws/config). Used to provide completion for the asp function.

Plugin options

Set SHOW_AWS_PROMPT=false in your zshrc file if you want to prevent the plugin from modifying your RPROMPT.

Theme

The plugin creates an aws_prompt_info function that you can use in your theme, which displays the current $AWS_PROFILE. It uses two variables to control how that is shown:

ZSH_THEME_AWS_PREFIX: sets the prefix of the AWS_PROFILE. Defaults to <aws:.
ZSH_THEME_AWS_SUFFIX: sets the suffix of the AWS_PROFILE. Defaults to >.