2018-10-28 13:17:41 +01:00
|
|
|
# aws
|
|
|
|
|
|
|
|
|
|
This plugin provides completion support for [awscli](https://docs.aws.amazon.com/cli/latest/reference/index.html)
|
2019-03-24 19:37:07 +01:00
|
|
|
and a few utilities to manage AWS profiles and display them in the prompt.
|
2018-10-28 13:17:41 +01:00
|
|
|
|
|
|
|
|
To use it, add `aws` to the plugins array in your zshrc file.
|
|
|
|
|
|
|
|
|
|
```zsh
|
|
|
|
|
plugins=(... aws)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Plugin commands
|
|
|
|
|
|
2019-03-24 19:37:07 +01:00
|
|
|
* `asp [<profile>]`: Sets `$AWS_PROFILE` and `$AWS_DEFAULT_PROFILE` (legacy) to `<profile>`.
|
2019-03-24 19:46:27 +01:00
|
|
|
It also sets `$AWS_EB_PROFILE` to `<profile>` for the Elastic Beanstalk CLI.
|
2019-03-24 19:37:07 +01:00
|
|
|
Run `asp` without arguments to clear the profile.
|
2018-10-28 13:17:41 +01:00
|
|
|
|
2019-03-24 19:37:07 +01:00
|
|
|
* `agp`: Gets the current value of `$AWS_PROFILE`.
|
2018-10-28 13:17:41 +01:00
|
|
|
|
2019-03-24 19:37:07 +01:00
|
|
|
* `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 `>`.
|
