Awsx NPM | npm.io

awsx

AWS CLI profile switcher with MFA support

Usage

Installation

// npm
npm install -g awsx

// yarn
yarn global add awsx

Add the following to your .bash_profile or .bashrc:

alias awsx="source _awsx"

Reload your profile by launching a new shell or running source ~/.bash_profile.

Upgrading

// npm
npm install -g awsx

// yarn
yarn global upgrade awsx --latest

Switching profiles

`awsx` or `awsx [profile]` or `awsx [profile] [assume-role-profile]`

If you don't specify a profile name (or an assume role profile name, if applicable) you will be prompted to choose from one of your existing profiles. If the selected profile has MFA enabled and you want to force a new MFA login use the --force-mfa flag.

Adding a new profile

`awsx add-profile [profile] [access-key] [secret-key] [key-max-age] [default-region] [output-format] [mfa-arn] [mfa-expiry]`

NOTE: If you don't provide inputs you will be prompted for them.

Finding your MFA ARN

You can find your MFA ARN by logging into the AWS Console, clicking on your name in the menu and then clicking on "My Security Credentials". Under the "Multi-factor authentication (MFA)" section there should be an "Assigned MFA device" heading. The string below that that starts with arn:aws:iam:: is your MFA ARN.

If you don't have MFA set up on your AWS account you can enable it by following these instructions.

Adding MFA support to an existing profile

`awsx enable-mfa [profile]`

Removing MFA support from an existing profile

`awsx disable-mfa [profile]`

Removing a profile

`awsx remove-profile [profile]`

Get current profile

`awsx current-profile`

Adding an assume role profile

`awsx add-assume-role-profile [profile] [parent-profile] [role-arn] [default-region] [output-format]`

Removing an assume role profile

`awsx remove-assume-role-profile [profile]`

Show what AWS account and identity you're using

`awsx whoami` or `awsx status`

Set access key maximum age

`awsx set-key-max-age [profile] [max-age]`

NOTE: use 0 days for no maximum age

Contributing

If you'd like to contribute to awsx we recommend that you first open an issue to discuss your proposed change.

Fork this repo
Clone the forked repo
Install dependencies: npm install

Development

`npm start`

Building

`npm run build`

To clean the build directory run npm run clean

Testing

`npm run test`

Publishing

Update the version in package.json
Add a CHANGELOG entry
Commit your changes
Run npm pack --dry-run to see what will be published
Run npm publish
Create a release on GitHub. Use the version as the tag and release name. For example for version 1.0.0 the tag and release name would be v1.0.0.