ylib/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-28 20:35:17 +08:00
Code Projects Releases Wiki Activity
8cbdd79517
ohmyzsh/plugins/aws/README.md
Logan Lindquist 8cbdd79517 aws: set AWS_EB_PROFILE for the EB CLI (#7388) 
Added AWS_EB_PROFILE environment variable to the AWS Plugin. The EB CLI uses this
variable instead of the primary AWS_PROFILE variable to keep track of what profile
it is using.

https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-configuration.html
2019-03-24 19:46:27 +01:00

1.2 KiB
Raw Blame History

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