Skip to main content
https://github.com/MacHu-GWU/awscli_mate-project/workflows/CI/badge.svg https://codecov.io/gh/MacHu-GWU/awscli_mate-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/awscli_mate.svg https://img.shields.io/pypi/l/awscli_mate.svg https://img.shields.io/pypi/pyversions/awscli_mate.svg https://img.shields.io/badge/Release_History!--None.svg?style=social https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to awscli_mate Documentation

awscli_mate improves the original AWS CLI.

Make sure you have done:

pip install awscli_mate
pip install boto3
pip install fire

Set AWS Profile as Default

It is very common that you wants to set a profile as the default when using a tools that doesn’t support explicit --profile ... argument. awscli_mate provides a command to do this for you. It will update your .aws/config and .aws/credentials file and set the default profile to the one you specified.

Example:

awscli_mate set_profile_as_default --profile=your_profile

One Click MFA auth

Based on this AWS re:Post How do I use an MFA token to authenticate access to my AWS resources through the AWS CLI?, you have to run aws sts get-session-token ... command to get some token, and manually copy and paste them to either environment variable or .aws/credentials file. This is a bit tedious. awscli_mate provides a one-click command to do this for you. Basically, it will use a base profile to get the token, let’s say it is your_profile, and automatically create / update a new profile called your_profile_mfa in your .aws/config and .aws/credentials file. So you can keep using the your_profile_mfa in your application.

Example:

awscli_mate mfa_auth --profile=your_profile --mfa_code=123456 --hours=12 --overwrite_default=True

Note that this command also automatically set the MFA profile as default profile. If you don’t want to set the your_profile_mfa as default profile automatically, you can just remove the --overwrite_default part.

Use awscli_mate as a Python Library

See example.

Use awscli_mate as a Interactive CLI

Set named AWS Profile as default

https://github.com/MacHu-GWU/awscli_mate-project/assets/6800411/c031a52a-2b4e-4dde-85f1-ab558aa1644f

Do MFA Authentication

https://github.com/MacHu-GWU/awscli_mate-project/assets/6800411/5cc9ddef-18a5-4d76-942f-4be1e97601aa

Keyboard shortcuts:

  • hit Ctrl + E or UP to move item selection up.

  • hit Ctrl + R to scroll item selection up.

  • hit Ctrl + D or DOWN to move item selection up.

  • hit Ctrl + F to scroll item selection up.

  • hit Ctrl + H or LEFT to move query input cursor to the left (this won’t work on Windows).

  • hit Ctrl + L or RIGHT to move query input cursor to the right.

  • hit Ctrl + G to move query input cursor to the previous word.

  • hit Ctrl + K to move query input cursor to the next word.

  • hit Ctrl + X to clear the query input.

  • hit Tab to auto-complete.

  • hit BACKSPACE to delete query input backward.

  • hit DELETE to delete query input forward.

  • hit Enter to run it.

Install

awscli_mate is released on PyPI, so all you need is:

$ pip install awscli_mate

To upgrade to latest version:

$ pip install --upgrade awscli_mate

Metadata

Release files for awscli-mate 1.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for awscli-mate 1.1.3
File Size Uploaded
awscli_mate-1.1.3.tar.gz 21.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for awscli-mate 1.1.3
File Interpreter ABI Platform
awscli_mate-1.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 39.4 kB

Release files / awscli_mate-1.1.3.tar.gz

Download URL awscli_mate-1.1.3.tar.gz
Size 21.1 kB
Tags Source
SHA-256 checksum
How to use checksums
3c487399304d335bbff9b63268b105ea9caba88862baf8eb7b6c432abf911edb
BLAKE2b-256 checksum
How to use checksums
7b43dc73ed11bf7eaa67313020b0fb42489728d192e47e785acc753fc0048f97
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.11.8

Release files / awscli_mate-1.1.3-py3-none-any.whl

Download URL awscli_mate-1.1.3-py3-none-any.whl
Size 18.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
41e33216cea637d0efe244ca69a8bae411760ad5dce8182312e004a9bee2065d
BLAKE2b-256 checksum
How to use checksums
4056a1f18be88961bb09e52dd410d46c647e2344e54a8a2b121c62589ca7c267
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.11.8

Release history Release notifications | RSS feed

This release

1.1.3 This release

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.0.2

2 release files

1.0.1

2 release files

0.4.1

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.2.1

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page