Skip to content

Prowler CLI

Installation

Prowler is available as a project in PyPI. Install it as a Python package with Python >= 3.9, <= 3.12:

pipx installs Python applications in isolated environments. Use pipx for global installation.

Requirements:

  • Python >= 3.9, <= 3.12
  • pipx installed: pipx installation.
  • AWS, GCP, Azure and/or Kubernetes credentials

Commands:

pipx install prowler
prowler -v

Upgrade Prowler to the latest version:

pipx upgrade prowler
Warning

This method modifies the chosen installation environment. Consider using pipx for global installation.

Requirements:

  • Python >= 3.9, <= 3.12
  • Python pip >= 21.0.0
  • AWS, GCP, Azure, M365 and/or Kubernetes credentials

Commands:

pip install prowler
prowler -v

Upgrade Prowler to the latest version:

pip install --upgrade prowler

Requirements:

  • Have docker installed: https://docs.docker.com/get-docker/.
  • In the command below, change -v to your local directory path in order to access the reports.
  • AWS, GCP, Azure and/or Kubernetes credentials

Containers are built for linux/amd64. If your workstation's architecture is different, please set DOCKER_DEFAULT_PLATFORM=linux/amd64 in your environment or use the --platform linux/amd64 flag in the docker command.

Commands:

docker run -ti --rm -v /your/local/dir/prowler-output:/home/prowler/output \
--name prowler \
--env AWS_ACCESS_KEY_ID \
--env AWS_SECRET_ACCESS_KEY \
--env AWS_SESSION_TOKEN toniblyx/prowler:latest

Requirements for Developers:

Commands:

git clone https://github.com/prowler-cloud/prowler
cd prowler
poetry install
poetry run python prowler-cli.py -v
Note

If you want to clone Prowler from Windows, use git config core.longpaths true to allow long file paths.

Requirements:

  • Python >= 3.9, <= 3.12
  • AWS, GCP, Azure and/or Kubernetes credentials

Commands:

python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install prowler
prowler -v

Requirements:

  • Ubuntu 23.04 or above, if you are using an older version of Ubuntu check pipx installation and ensure you have Python >= 3.9, <= 3.12.
  • Python >= 3.9, <= 3.12
  • AWS, GCP, Azure and/or Kubernetes credentials

Commands:

sudo apt update
sudo apt install pipx
pipx ensurepath
pipx install prowler
prowler -v

Requirements:

  • Brew installed in your Mac or Linux
  • AWS, GCP, Azure and/or Kubernetes credentials

Commands:

brew install prowler
prowler -v

After the migration of AWS CloudShell from Amazon Linux 2 to Amazon Linux 2023 [1] [2], there is no longer a need to manually compile Python 3.9 as it is already included in AL2023. Prowler can thus be easily installed following the generic method of installation via pip. Follow the steps below to successfully execute Prowler v4 in AWS CloudShell:

Requirements:

  • Open AWS CloudShell bash.

Commands:

sudo bash
adduser prowler
su prowler
python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install prowler
cd /tmp
prowler aws
Note

To download the results from AWS CloudShell, select Actions -> Download File and add the full path of each file. For the CSV file it will be something like /tmp/output/prowler-output-123456789012-20221220191331.csv

Requirements:

  • Open Azure CloudShell bash.

Commands:

python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install prowler
cd /tmp
prowler azure --az-cli-auth

Container versions

The available versions of Prowler CLI are the following:

  • latest: in sync with master branch (please note that it is not a stable version)
  • v4-latest: in sync with v4 branch (please note that it is not a stable version)
  • v3-latest: in sync with v3 branch (please note that it is not a stable version)
  • <x.y.z> (release): you can find the releases here, those are stable releases.
  • stable: this tag always point to the latest release.
  • v4-stable: this tag always point to the latest release for v4.
  • v3-stable: this tag always point to the latest release for v3.

The container images are available here: