# Installation and Quick Start

# Pre-Requisites

  • Awsume requires Python 3.5 or greater.
  • Awsume can be installed via pip, so make sure that the location that pip installs binaries is included on your PATH environment variable.

# Installation


Homebrew is not an officially supported method of installing awsume

The officially-recommended way to install awsume is via pipx (opens new window)

Awsume can be installed via one of the following commands:

pipx install awsume
pip install awsume

# Extra Features

Awsume uses Python's extras_require (opens new window) to add additional functionality with different dependencies.

  • awsume[saml] - Install dependencies required to support SAML assertion handling
  • awsume[fuzzy] - Install dependencies required to support fuzzy profile name matching
  • awsume[console] - Install the awsume-console-plugin (opens new window) with awsume

# Alias Setup

If you're running on a unix-like system, you must have an alias setup for awsume, that may or may not look something like this:

alias awsume=". awsume"

Awsume will make an attempt to place this in a login script such as your ~/.bash_profile or ~/.bashrc when it's being installed, so you may need to restart your terminal or re-source your login file.

If this automatic installation is causing you problems, you can disable it through setting an environment variable like this:

AWSUME_SKIP_ALIAS_SETUP=true pip install awsume

Sometimes, however, things (such as file permission issues) can prevent awsume from injecting the alias. If this is the case, we provided a utility to setup the alias after the fact, so check out the awsume-configure guide here.

For debug purposes, in order to get output from the post_install setup, you must use pip's -v flag like this:

pip install awsume -v

# Quick Usage

Once you have your alias setup, awsume can now work.

Run the following command and you'll be able to execute commands and run scripts with that profile's credentials.

awsume <profile_name>

Read more about awsume's usage here.