mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-11-11 00:10:08 +00:00
aws: add README (#7357)
This commit is contained in:
parent
f96d18ca93
commit
684feffc35
1 changed files with 20 additions and 0 deletions
20
plugins/aws/README.md
Normal file
20
plugins/aws/README.md
Normal file
|
@ -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.
|
Loading…
Reference in a new issue