diff --git a/README.md b/README.md index 73dc071358..b8ca63f4c8 100644 --- a/README.md +++ b/README.md @@ -239,6 +239,21 @@ pnpm start > Once configured, access the Prowler App at http://localhost:3000. Sign up using your email and password to get started. +**Pre-commit Hooks Setup** + +Some pre-commit hooks require tools installed on your system: + +1. **Install [TruffleHog](https://github.com/trufflesecurity/trufflehog#install)** (secret scanning) — see the [official installation options](https://github.com/trufflesecurity/trufflehog#install). + +2. **Install [Safety](https://github.com/pyupio/safety)** (dependency vulnerability checking): + + ```console + # Requires a Python environment (e.g. via pyenv) + pip install safety + ``` + +3. **Install [Hadolint](https://github.com/hadolint/hadolint#install)** (Dockerfile linting) — see the [official installation options](https://github.com/hadolint/hadolint#install). + ## Prowler CLI ### Pip package Prowler CLI is available as a project in [PyPI](https://pypi.org/project/prowler-cloud/). Consequently, it can be installed using pip with Python >=3.10, <3.13: