linux/ohmyzsh
Watch
1
0
Fork
You've already forked ohmyzsh
 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2026-08-07 06:08:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor aws plugin docs

Browse source
This commit is contained in:
Rohit Sharma 2026-06-15 06:10:54 +05:30 • committed by GitHub
commit 9bf48c81ee
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 20 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

55
plugins/aws/README.md
View file

@ -12,39 +12,24 @@ plugins=(... aws)
## Plugin commands ## Plugin commands
* `asp [<profile>]`: sets `$AWS_PROFILE` and `$AWS_DEFAULT_PROFILE` (legacy) to `<profile>`. | Command | Description |
It also sets `$AWS_EB_PROFILE` to `<profile>` for the Elastic Beanstalk CLI. It sets `$AWS_PROFILE_REGION` for display in `aws_prompt_info`. |----------|-------------|
Run `asp` without arguments to clear the profile. | `asp [<profile>]` | sets `$AWS_PROFILE` and `$AWS_DEFAULT_PROFILE` (legacy) to `<profile>`. It also sets `$AWS_EB_PROFILE` to `<profile>` for the Elastic Beanstalk CLI. It sets `$AWS_PROFILE_REGION` for display in `aws_prompt_info`. Run `asp` without arguments to clear the profile. |
* `asp [<profile>] login`: If AWS SSO has been configured in your aws profile, it will run the `aws sso login` command following profile selection. | `asp [<profile>] login` | If AWS SSO has been configured in your aws profile, it will run the `aws sso login` command following profile selection. |
* `asp [<profile>] login [<sso_session>]`: In addition to `asp [<profile>] login`, if SSO session has been configured in your aws profile, it will run the `aws sso login --sso-session <sso_session>` command following profile selection. | `asp [<profile>] login [<sso_session>]` | In addition to `asp [<profile>] login`, if SSO session has been configured in your aws profile, it will run the `aws sso login --sso-session <sso_session>` command following profile selection. |
* `asp [<profile>] logout`: If AWS SSO has been configured in your aws profile, it will run the `aws sso logout` command following profile selection. | `asp [<profile>] logout` | If AWS SSO has been configured in your aws profile, it will run the `aws sso logout` command following profile selection. |
| `asr [<region>]` | sets `$AWS_REGION` and `$AWS_DEFAULT_REGION` (legacy) to `<region>`. Run `asr` without arguments to clear the profile. |
* `asr [<region>]`: sets `$AWS_REGION` and `$AWS_DEFAULT_REGION` (legacy) to `<region>`. | `acp [<profile>] [<mfa_token>]` | in addition to `asp` functionality, it actually changes the profile by assuming the role specified in the `<profile>` configuration. It supports MFA and sets `$AWS_ACCESS_KEY_ID`, `$AWS_SECRET_ACCESS_KEY` and `$AWS_SESSION_TOKEN`, if obtained. It requires the roles to be configured as per the [official guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-role.html). Run `acp` without arguments to clear the profile. |
Run `asr` without arguments to clear the profile. | `agp` | gets the current value of `$AWS_PROFILE`. |
| `agr` | gets the current value of `$AWS_REGION`. |
* `acp [<profile>] [<mfa_token>]`: in addition to `asp` functionality, it actually changes | `aws_change_access_key` | changes the AWS access key of a profile. |
the profile by assuming the role specified in the `<profile>` configuration. It supports | `aws_profiles` | lists the available profiles in the `$AWS_CONFIG_FILE` (default: `~/.aws/config`). Used to provide completion for the `asp` function. |
MFA and sets `$AWS_ACCESS_KEY_ID`, `$AWS_SECRET_ACCESS_KEY` and `$AWS_SESSION_TOKEN`, if | `aws_regions` | lists the available regions. Used to provide completion for the `asr` function. |
obtained. It requires the roles to be configured as per the
[official guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-role.html).
Run `acp` without arguments to clear the profile.
* `agp`: gets the current value of `$AWS_PROFILE`.
* `agr`: gets the current value of `$AWS_REGION`.
* `aws_change_access_key`: changes the AWS access key of a profile.
* `aws_profiles`: lists the available profiles in the `$AWS_CONFIG_FILE` (default: `~/.aws/config`).
Used to provide completion for the `asp` function.
* `aws_regions`: lists the available regions.
Used to provide completion for the `asr` function.
## Plugin options ## Plugin options
* Set `SHOW_AWS_PROMPT=false` in your zshrc file if you want to prevent the plugin from modifying your RPROMPT. * Set `SHOW_AWS_PROMPT=false` in your zshrc file if you want to prevent the plugin from modifying your `RPROMPT`.
Some themes might overwrite the value of RPROMPT instead of appending to it, so they'll need to be fixed to Some themes might overwrite the value of `RPROMPT` instead of appending to it, so they'll need to be fixed to
see the AWS profile/region prompt. see the AWS profile/region prompt.
* Set `AWS_PROFILE_STATE_ENABLED=true` in your zshrc file if you want the aws profile to persist between shell sessions. * Set `AWS_PROFILE_STATE_ENABLED=true` in your zshrc file if you want the aws profile to persist between shell sessions.
@ -57,15 +42,15 @@ plugins=(... aws)
The plugin creates an `aws_prompt_info` function that you can use in your theme, which displays The plugin creates an `aws_prompt_info` function that you can use in your theme, which displays
the current `$AWS_PROFILE` and `$AWS_REGION`. It uses four variables to control how that is shown: the current `$AWS_PROFILE` and `$AWS_REGION`. It uses four variables to control how that is shown:
* ZSH_THEME_AWS_PROFILE_PREFIX: sets the prefix of the AWS_PROFILE. Defaults to `<aws:`. * `ZSH_THEME_AWS_PROFILE_PREFIX`: sets the prefix of the `AWS_PROFILE`. Defaults to `<aws:`.
* ZSH_THEME_AWS_PROFILE_SUFFIX: sets the suffix of the AWS_PROFILE. Defaults to `>`. * `ZSH_THEME_AWS_PROFILE_SUFFIX`: sets the suffix of the `AWS_PROFILE`. Defaults to `>`.
* ZSH_THEME_AWS_REGION_PREFIX: sets the prefix of the AWS_REGION. Defaults to `<region:`. * `ZSH_THEME_AWS_REGION_PREFIX`: sets the prefix of the `AWS_REGION`. Defaults to `<region:`.
* ZSH_THEME_AWS_REGION_SUFFIX: sets the suffix of the AWS_REGION. Defaults to `>`. * `ZSH_THEME_AWS_REGION_SUFFIX`: sets the suffix of the `AWS_REGION`. Defaults to `>`.
* ZSH_THEME_AWS_DIVIDER: sets the divider between ZSH_THEME_AWS_PROFILE_SUFFIX and ZSH_THEME_AWS_REGION_PREFIX. Defaults to ` ` (single space). * `ZSH_THEME_AWS_DIVIDER`: sets the divider between `ZSH_THEME_AWS_PROFILE_SUFFIX` and `ZSH_THEME_AWS_REGION_PREFIX`. Defaults to ` ` (single space).
## Configuration ## Configuration