Installation

Requirements

• Python 3.8 or higher
• Valid AWS credentials configured on the machine (environment variables, ~/.aws/credentials, or an instance role)

Install methods

From GitHub (recommended)

pip install git+https://github.com/baeziy/AWSault.git

The awsault command is now available globally.

Using pipx (isolated environment)

pipx install git+https://github.com/baeziy/AWSault.git

This installs AWSault in its own virtual environment so it doesn't interfere with other Python packages.

From source

git clone https://github.com/baeziy/AWSault.git
cd AWSault
pip install .

Without installing

If you just want to run it without putting anything in your PATH:

git clone https://github.com/baeziy/AWSault.git
cd AWSault
pip install -r requirements.txt
python -m awsault

Dependencies

AWSault depends on three Python packages (installed automatically):

Package	Minimum Version	Purpose
boto3	1.26.0	AWS SDK for Python
botocore	1.29.0	Low-level AWS interface (boto3 dependency)
rich	13.0.0	Terminal formatting, tables, progress bars

Adding to PATH

After installing with pip install ., the awsault command should be available. If your terminal says command not found, pip installed the script to a directory that isn't in your PATH.

Linux

# pip installs scripts to ~/.local/bin
export PATH="$HOME/.local/bin:$PATH"

# make it permanent (add to your shell config)
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# if using zsh:
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

macOS

# same as Linux for most setups
export PATH="$HOME/.local/bin:$PATH"

# make it permanent
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

# if using Homebrew Python, scripts may be in:
#   /opt/homebrew/bin (Apple Silicon)
#   /usr/local/bin (Intel)
# these are usually already in PATH

Windows

# find where pip installed the script
python -m site --user-site
# the Scripts folder is next to the site-packages folder
# e.g. C:\Users\YourName\AppData\Roaming\Python\Python312\Scripts

# add to PATH permanently (PowerShell, run as Administrator)
$scriptPath = (python -m site --user-site) -replace 'site-packages','Scripts'
[Environment]::SetEnvironmentVariable("Path", "$env:Path;$scriptPath", "User")

# or add manually:
# Settings > System > About > Advanced system settings > Environment Variables
# edit the "Path" variable under User variables and add the Scripts folder

Verify installation

After updating PATH, restart your terminal and run:

awsault --list-services

You should see a list of 120+ supported AWS services.

Windows terminal notes

On Windows, if colors don't render properly, make sure you're running Windows Terminal or a terminal emulator that supports ANSI escape codes. The default Windows Terminal (available from the Microsoft Store) works fine. Legacy cmd.exe may not display colors correctly.