From b40736918bf7aa6099f3d65dfa2eb7bdea32b434 Mon Sep 17 00:00:00 2001 From: Toni de la Fuente Date: Thu, 2 Mar 2023 10:21:57 +0100 Subject: [PATCH] docs(install): Add brew and github installation to quick start (#1991) --- docs/index.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/docs/index.md b/docs/index.md index 486cce87..429cc449 100644 --- a/docs/index.md +++ b/docs/index.md @@ -87,6 +87,23 @@ Prowler is available as a project in [PyPI](https://pypi.org/project/prowler-clo prowler -v ``` +=== "GitHub" + + _Requirements for Developers_: + + * AWS and/or Azure credentials + * `git`, `Python >= 3.9`, `pip` and `poetry` installed (`pip install poetry`) + + _Commands_: + + ``` + git clone https://github.com/prowler-cloud/prowler + cd prowler + poetry shell + poetry install + python prowler.py -v + ``` + === "Amazon Linux 2" _Requirements_: @@ -103,6 +120,20 @@ Prowler is available as a project in [PyPI](https://pypi.org/project/prowler-clo prowler -v ``` +=== "Brew" + + _Requirements_: + + * `Brew` installed in your Mac or Linux + * AWS and/or Azure credentials + + _Commands_: + + ``` bash + brew install prowler + prowler -v + ``` + === "AWS CloudShell" Prowler can be easely executed in AWS CloudShell but it has some prerequsites to be able to to so. AWS CloudShell is a container running with `Amazon Linux release 2 (Karoo)` that comes with Python 3.7, since Prowler requires Python >= 3.9 we need to first install a newer version of Python. Follow the steps below to successfully execute Prowler v3 in AWS CloudShell: