Jorge Luis Vargas Aguilar <yorch.veintemil+github@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date
Message
aws: add README (#7357)
Diff
1diff --git a/plugins/aws/README.md b/plugins/aws/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..8a45199b8e95d0882fbac95219b3375a5278f53b
4--- /dev/null
5+++ b/plugins/aws/README.md
6@@ -0,0 +1,20 @@
7+# aws
8+
9+This plugin provides completion support for [awscli](https://docs.aws.amazon.com/cli/latest/reference/index.html)
10+and a few utilities to manage AWS profiles: a function to change profiles with autocompletion support
11+and a function to get the current AWS profile. The current AWS profile is also displayed in `RPROMPT`.
12+
13+To use it, add `aws` to the plugins array in your zshrc file.
14+
15+```zsh
16+plugins=(... aws)
17+```
18+
19+## Plugin commands
20+
21+* `asp <profile>`: Sets `AWS_PROFILE` and `AWS_DEFAULT_PROFILE` (legacy) to `<profile>`.
22+It also adds it to your RPROMPT.
23+
24+* `agp`: Gets the current value of `AWS_PROFILE`.
25+
26+* `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.