zsh-aws-vault

oh-my-zsh plugin for aws-vault

Installation

oh-my-zsh

This plugin is intended to be used with oh-my-zsh

1. $ cd ~/.oh-my-zsh/custom/plugins (you may have to create the folder)
2. $ git clone https://github.com/blimmer/zsh-aws-vault.git
3. In your .zshrc, add zsh-aws-vault to your oh-my-zsh plugins:

plugins=(
  git
  ruby
  zsh-aws-vault
)

zgen

1. add zgen load blimmer/zsh-aws-vault to your '!saved/save' block
2. zgen update

Features

This plugin is pretty simple - it provides:

• aliases
• prompt segment

Aliases

avli

Login in Private Browsing Window

This alias is currently only supported in OSX and Linux.

This alias will open a new browser window after getting the temporary login URL for your profile.

You can specify a specific browser to handle your login URL by setting AWS_VAULT_PL_BROWSER to the bundle name of the browser. By default, it will pick your default URL handler in MacOS. It supports the following browsers:

You can pass arbitrary parameters when launching the browser by setting the optional AWS_VAULT_PL_BROWSER_LAUNCH_OPTS environment variable. For example, if you wanted to start new avli browser windows maximized, you can set AWS_VAULT_PL_BROWSER_LAUNCH_OPTS="--start-maximized". Refer to your browser documentation for possible options.

avsh

Create a shell for a given profile.

For example, place the relevant AWS environment variables for your default profile by running:

avsh default

Prompt Segment

This prompt segment echos out the current aws-vault profile you're logged into. I use this for adding a segment into my custom agnoster theme.

For instance, this code:

prompt_aws_vault() {
  local vault_segment
  vault_segment="`prompt_aws_vault_segment`"
  [[ $vault_segment != '' ]] && prompt_segment cyan black "$vault_segment"
}

Produces this segment in my prompt:

The instructions to customize the prompt vary based on the theme you use. In some cases, you'll need to create a copy of the theme file and edit it to include the prompt segment. You can check out my custom agnoster theme to see how I updated the prompt.

Prompt Customization

You can customize the prompt segment behavior by overriding these variables:

Multi Factor Authentication (MFA)

You can override the default MFA prompt by adding the AWS_VAULT_PL_MFA environment variable.