Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonscheiding/zsh-plugin-aws-vault-profiles
Oh My ZSH plugin integration aws-vault with $AWS_PROFILE
https://github.com/jonscheiding/zsh-plugin-aws-vault-profiles
Last synced: about 1 month ago
JSON representation
Oh My ZSH plugin integration aws-vault with $AWS_PROFILE
- Host: GitHub
- URL: https://github.com/jonscheiding/zsh-plugin-aws-vault-profiles
- Owner: jonscheiding
- License: mit
- Created: 2023-02-03T15:37:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-15T16:29:32.000Z (9 months ago)
- Last Synced: 2024-04-09T21:23:13.927Z (about 1 month ago)
- Language: Shell
- Size: 45.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Lists
- awesome-zsh-plugins - aws-vault-profiles - Plugin that integrates usage of [aws-vault](https://github.com/99designs/aws-vault) with the `$AWS_PROFILE` environment variable. (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - aws-vault-profiles - Plugin that integrates usage of <b><code> 8178⭐</code></b> <b><code> 800🍴</code></b> [aws-vault](https://github.com/99designs/aws-vault)) with the `$AWS_PROFILE` environment variable. (Plugins / ZSH on Windows)
- fucking-awesome-zsh-plugins - aws-vault-profiles - Plugin that integrates usage of <b><code> 8148⭐</code></b> <b><code> 795🍴</code></b> [aws-vault](https://github.com/99designs/aws-vault)) with the `$AWS_PROFILE` environment variable. (Plugins / ZSH on Windows)
README
# zsh-awsvault
oh-my-zsh plugin for [aws-vault](https://github.com/99designs/aws-vault) providing a couple of functions that integrate aws-vault seamlessly with the `AWS_PROFILE` environment variable.
This is most useful when used alongside a profile-switching tool, such as
[awsp](https://github.com/johnnyopao/awsp).
## Installation
### Oh My ZSH
This plugin is intended to be used with [oh-my-zsh](https://ohmyz.sh/). To install it with that framework:
1. Clone the repo to the Oh My ZSH plugins directory:
```shell
$ git clone https://github.com/jonscheiding/zsh-plugin-aws-vault-profiles $ZSH_CUSTOM/plugins/aws-vault-profiles
```
2. In your `.zshrc`, add `aws-vault-profiles` to your plugins list:
```
plugins=(git ruby ... aws-vault-profiles)
```
### Vanilla ZSH
This plugin does not depend on any Oh My ZSH functionality, so you can also use it with plain ZSH:
1. Clone the repo somewhere:
```shell
$ git clone https://github.com/jonscheiding/zsh-plugin-aws-vault-profiles ~/.zsh-plugin-aws-vault-profiles
```
2. In your `.zshrc`, source the plugin file:
```
source ~/.zsh-plugin-aws-vault-profiles/awsvault.plugin.zsh
```
## Features
This plugin provides the following features:
### Command `awsv`
Executes a command with `aws-vault`, using the profile set in the `$AWS_PROFILE` environment variable (or
default, if none is set).
If no command is provided, executes into an `aws-vault` shell.
So, the following are roughly equivalent:
```shell
$ awsv run-some-command
```
```shell
$ aws-vault exec ${AWS_PROFILE:-default} -- run-some-command
```
As are the following:
```shell
$ awsv
```
```shell
$ aws-vault exec ${AWS_PROFILE:-default}
```
The main difference is that if you are already in an `aws-vault` shell (detected by the existence of an
`$AWS_VAULT` environment variable), it will not nest you into another one; it will just execute the command
directly.
### Command `awsc`
Generate temporary credentials using the profile set in the `$AWS_PROFILE` environment variable (or default,
if none is set), and stores them under that profile in your `$AWS_SHARED_CREDENTIALS_FILE` (by default,
`~/.aws/credentials`).
This is useful for commands which have a hard-coded expectation that they will find credentials in that file,
vs using the various resolution mechanisms exposed by the AWS SDK. The
[AWS Amplify CLI](https://docs.amplify.aws/cli/) is an example of this.
If `awsc` is provided with a command, it will execute that command directly after storing the temporary
credentials.
So, the following are roughly equivalent:
```shell
$ awsc run-some-command
```
```shell
$ aws-vault exec ${AWS_PROFILE:-default} -- bash -c 'echo $AWS_ACCESS_KEY_ID; echo $AWS_SECRET_ACCESS_KEY; echo $AWS_SESSION_TOKEN'
$ # Place the provided values in ~/.aws/credentials
$ run-some-command
```
This command requires the [crudini](https://github.com/pixelb/crudini) tool.
### Prompt segment
This plugin defines a prompt segment called `awsvault` which you can use with various Oh My ZSH themes such as
[powerlevel10k](https://github.com/romkatv/powerlevel10k). It will show the current value of the
`$AWS_PROFILE` variable, along with an icon indicating whether you are inside an `aws-vault` session.
