https://github.com/eastokes/aws-plugin-zsh

This plugin provides completion support for awscli to manage AWS profiles/regions and display them in the prompt.
https://github.com/eastokes/aws-plugin-zsh

Last synced: about 2 months ago
JSON representation

This plugin provides completion support for awscli to manage AWS profiles/regions and display them in the prompt.

• Host: GitHub
• URL: https://github.com/eastokes/aws-plugin-zsh
• Owner: eastokes
• License: mit
• Created: 2019-07-27T23:22:34.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2019-07-27T23:31:47.000Z (almost 5 years ago)
• Last Synced: 2024-01-25T17:35:40.777Z (4 months ago)
• Language: Shell
• Size: 2.93 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-zsh-plugins - aws-completions - Adds completion support for `awscli` to manage AWS profiles/regions and display them in the prompt. (Completions / ZSH on Windows)
• fucking-awesome-zsh-plugins - aws-completions - Adds completion support for `awscli` to manage AWS profiles/regions and display them in the prompt. (Completions / ZSH on Windows)
• awesome-zsh-plugins - aws-completions - Adds completion support for `awscli` to manage AWS profiles/regions and display them in the prompt. (Completions / ZSH on Windows)
• awesome-zsh-plugins - aws-completions - Adds completion support for `awscli` to manage AWS profiles/regions and display them in the prompt. (Completions / Zinit (née zplugin))

README

        
# aws-plugin-zsh

This plugin provides completion support for [awscli](https://docs.aws.amazon.com/cli/latest/reference/index.html)

to manage AWS profiles/regions and display them in the prompt.

To use it, add `aws` to the plugins array in your zshrc file.

```zsh

plugins=(... aws)

```

## Plugin commands

* `asp [ ]`: sets `$AWS_PROFILE` and `$AWS_DEFAULT_PROFILE` (legacy) to `` and `$AWS_DEFAULT_REGION` to ``.

  It also sets `$AWS_EB_PROFILE` to `` for the Elastic Beanstalk CLI.

  Run `asp` without arguments to clear the profile.

* `agp`: gets the current value of `$AWS_PROFILE`.

* `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.

## Plugin options

* 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

  see the AWS profile prompt.

## Theme

The plugin creates an `aws_prompt_info` function that you can use in your theme, which displays

the current `$AWS_PROFILE`. It uses two variables to control how that is shown:

- ZSH_THEME_AWS_PREFIX: sets the prefix of the AWS_PROFILE. Defaults to ``.