kevin/ohmyzsh
1
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-15 09:58:47 -07:00
Code Issues Packages Projects Releases Wiki Activity
532a784b80
ohmyzsh/plugins/aws/README.md
David Kane 532a784b80 aws: refactor AWS plugin (#7615) 
* Update the AWS plugin to support disabling RPROMT display:
  Use a $SHOW_AWS_PROMPT option.

* Refactoring aws plugin:
  Exposing customizable aws_prompt_info function to be used in themes.

* Set aws prompt prefix and suffix to original values and fix README

Co-authored-by: "Vassilis S. Moustakas" <vsmoustakas@gmail.com>
2019-03-24 19:37:45 +01:00

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