diff options
| author | Kozlov Alexander <badryke@gmail.com> | 2018-11-16 13:38:43 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-16 13:38:43 +0300 |
| commit | 8c95c52353118643ac3dbd9b0c185a3129b84bf8 (patch) | |
| tree | ee7497251b7a541480ae5c6a97b63b14381ed5ee /plugins/aws/README.md | |
| parent | dd30cf104c9ca42d89d26a134382ca421869ce7e (diff) | |
| parent | 3d8f2bda599c8c6d160dc448e5ab28aaf2d5e90d (diff) | |
| download | zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.gz zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.bz2 zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.zip | |
Merge branch 'master' into master
Diffstat (limited to 'plugins/aws/README.md')
| -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. |