diff options
| author | Jorge Luis Vargas Aguilar <yorch.veintemil+github@gmail.com> | 2018-10-28 05:17:41 -0700 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2018-10-28 13:17:41 +0100 |
| commit | 684feffc355df95c804a6a32196248bacfefebe7 (patch) | |
| tree | 1976610bc7e0a9a9f6d89a7c1350e2c58bf6b47f | |
| parent | f96d18ca935f9b9bd6f1c51cb5c821a0b18e9601 (diff) | |
| download | zsh-684feffc355df95c804a6a32196248bacfefebe7.tar.gz zsh-684feffc355df95c804a6a32196248bacfefebe7.tar.bz2 zsh-684feffc355df95c804a6a32196248bacfefebe7.zip | |
aws: add README (#7357)
| -rw-r--r-- | plugins/aws/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/aws/README.md b/plugins/aws/README.md new file mode 100644 index 000000000..8a45199b8 --- /dev/null +++ b/plugins/aws/README.md @@ -0,0 +1,20 @@ +# aws + +This plugin provides completion support for [awscli](https://docs.aws.amazon.com/cli/latest/reference/index.html) +and a few utilities to manage AWS profiles: a function to change profiles with autocompletion support +and a function to get the current AWS profile. The current AWS profile is also displayed in `RPROMPT`. + +To use it, add `aws` to the plugins array in your zshrc file. + +```zsh +plugins=(... aws) +``` + +## Plugin commands + +* `asp <profile>`: Sets `AWS_PROFILE` and `AWS_DEFAULT_PROFILE` (legacy) to `<profile>`. +It also adds it to your RPROMPT. + +* `agp`: Gets the current value of `AWS_PROFILE`. + +* `aws_profiles`: Lists the available profiles in the file referenced in `AWS_CONFIG_FILE` (default: ~/.aws/config). Used to provide completion for the `asp` function. |