Skip to content
Back to search

prowler-plugins

MarketplaceWorks with Claude CodeGitHub

Prowler Cloud security and compliance for Claude

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/prowler-cloud/prowler with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/prowler-cloud/prowler'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/prowler-cloud-prowler/badge.svg)](/listings/prowler-cloud-prowler)

HTML

<a href="/listings/prowler-cloud-prowler"><img src="/api/listings/prowler-cloud-prowler/badge.svg" alt="findsafeskills safety rating" /></a>

Install

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Prowler Local Server

Prowler Local Server offers flexible installation methods tailored to various environments:

> For detailed instructions on using Prowler Local Server, refer to the [usage guide](https://docs.prowler.com/user-guide/tutorials/prowler-app).

Docker Compose

Requirements

- `Docker Compose` installed: https://docs.docker.com/compose/install/.

Commands

_macOS/Linux:_

VERSION=$(curl -s https://api.github.com/repos/prowler-cloud/prowler/releases/latest | jq -r .tag_name)
curl -sLO "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/${VERSION}/docker-compose.yml"
# Environment variables can be customized in the .env file. Using default values in production environments is not recommended.
curl -sLO "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/${VERSION}/.env"
docker compose up -d

_Windows PowerShell:_

$VERSION = (Invoke-RestMethod -Uri "https://api.github.com/repos/prowler-cloud/prowler/releases/latest").tag_name
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/$VERSION/docker-compose.yml" -OutFile "docker-compose.yml"
# Environment variables can be customized in the .env file. Using default values in production environments is not recommended.
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/$VERSION/.env" -OutFile ".env"
docker compose up -d

> [!WARNING] > 🔒 For a secure setup, the API auto-generates a unique key pair, `DJANGO_TOKEN_SIGNING_KEY` and `DJANGO_TOKEN_VERIFYING_KEY`, and stores it in `~/.config/prowler-api` (non-container) or the bound Docker volume in `_data/api` (container). Never commit or reuse static/default keys. To rotate keys, delete the stored key files and restart the API.

Once configured, access Prowler Local Server at http://localhost:3000. Sign up using your email and password to get started.

Common Issues with Docker Pull Installation

> [!Note] If you want to use AWS role assumption (e.g., with the "Connect assuming IAM Role" option), you may need to mount your local `.aws` directory into the container as a volume (e.g., `- "${HOME}/.aws:/home/prowler/.aws:ro"`). There are several ways to configure credentials for Docker containers. See the [Troubleshooting](./docs/troubleshooting.mdx) section for more details and examples.

You can find more information in the [Troubleshooting](./docs/troubleshooting.mdx) section.

From GitHub

Requirements

- `git` installed. - `uv` installed: [uv installation](https://docs.astral.sh/uv/getting-started/installation/). - `pnpm` installed: [pnpm installation](https://pnpm.io/installation). - `Docker Compose` installed: https://docs.docker.com/compose/install/.

Commands to run the API

git clone https://github.com/prowler-cloud/prowler
cd prowler/api
uv sync
source .venv/bin/activate
set -a
source .env
docker compose up postgres valkey -d
cd src/backend
python manage.py migrate --database admin
gunicorn -c config/guniconf.py config.wsgi:application

> After completing the setup, access the API documentation at http://localhost:8080/api/v1/docs.

Commands to run the API Worker

git clone https://github.com/prowler-cloud/prowler
cd prowler/api
uv sync
source .venv/bin/activate
set -a
source .env
cd src/backend
python -m celery -A config.celery worker -l info -E

Commands to run the API Scheduler

git clone https://github.com/prowler-cloud/prowler
cd prowler/api
uv sync
source .venv/bin/activate
set -a
source .env
cd src/backend
python -m celery -A config.celery beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler

Commands to run the UI

git clone https://github.com/prowler-cloud/prowler
cd prowler/ui
pnpm install
pnpm run build
pnpm start

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 17 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. {
  2. "name": "prowler-plugins",
  3. "description": "Prowler Cloud security and compliance for Claude",
  4. "owner": {
  5. "name": "Prowler",
  6. "email": "support@prowler.com"
  7. },
  8. "plugins": [
  9. {
  10. "name": "prowler",
  11. "source": "./claude_plugins/prowler",
  12. "description": "Connect Claude to Prowler Cloud through the Prowler MCP server. Reads providers, scans, findings, compliance results and resources for AWS, Azure, GCP, Kubernetes, Microsoft 365, GitHub and the other providers listed at https://registry.prowler.com, and returns remediation guidance for failed checks. Writes are limited to Prowler Cloud itself: triggering scans, finding triage, mute rules and the mutelist, providers and integrations. Your cloud resources are not changed by the connector.",
  13. "category": "security",
  14. "homepage": "https://prowler.com"
  15. }
  16. ]
  17. }
README.md · README · 486 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <p align="center">
  2. <img align="center" alt="Prowler logo" src="https://github.com/prowler-cloud/prowler/blob/master/docs/img/prowler-logo-black.png#gh-light-mode-only" width="50%" height="50%">
  3. <img align="center" alt="Prowler logo" src="https://github.com/prowler-cloud/prowler/blob/master/docs/img/prowler-logo-white.png#gh-dark-mode-only" width="50%" height="50%">
  4. </p>
  5. <p align="center">
  6. <b><i>Prowler</b> is the Open Cloud Security Platform trusted by thousands to automate security and compliance in any cloud environment. With thousands of ready-to-use checks and compliance frameworks, Prowler delivers real-time, customizable monitoring and seamless integrations, making cloud security simple, scalable, and cost-effective for organizations of any size.
  7. </p>
  8. <p align="center">
  9. <b>The Agentic Cloud Defender</i></b>
  10. </p>
  11. <p align="center">
  12. <a href="https://cloud.prowler.com/sign-up">Try Prowler Cloud</a>
  13. </p>
  14. <p align="center">
  15. <a href="https://goto.prowler.com/slack"><img width="30" height="30" alt="Prowler community on Slack" src="https://github.com/prowler-cloud/prowler/assets/38561120/3c8b4ec5-6849-41a5-b5e1-52bbb94af73a"></a>
  16. <br>
  17. <a href="https://goto.prowler.com/slack">Join our Prowler community!</a>
  18. </p>
  19. <hr>
  20. <p align="center">
  21. <a href="https://goto.prowler.com/slack"><img alt="Slack Shield" src="https://img.shields.io/badge/slack-prowler-brightgreen.svg?logo=slack"></a>
  22. <a href="https://pypi.org/project/prowler/"><img alt="Python Version" src="https://img.shields.io/pypi/v/prowler.svg"></a>
  23. <a href="https://pypi.python.org/pypi/prowler/"><img alt="Python Version" src="https://img.shields.io/pypi/pyversions/prowler.svg"></a>
  24. <a href="https://pypistats.org/packages/prowler"><img alt="PyPI Downloads" src="https://img.shields.io/pypi/dw/prowler.svg?label=downloads"></a>
  25. <a href="https://hub.docker.com/r/toniblyx/prowler"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/toniblyx/prowler"></a>
  26. <a href="https://gallery.ecr.aws/prowler-cloud/prowler"><img width="120" height="19" alt="AWS ECR Gallery" src="https://user-images.githubusercontent.com/3985464/151531396-b6535a68-c907-44eb-95a1-a09508178616.png"></a>
  27. <a href="https://codecov.io/gh/prowler-cloud/prowler"><img alt="Codecov coverage" src="https://codecov.io/gh/prowler-cloud/prowler/graph/badge.svg?token=OflBGsdpDl"/></a>
  28. <a href="https://insights.linuxfoundation.org/project/prowler-cloud-prowler"><img alt="Linux Foundation insights health score" src="https://insights.linuxfoundation.org/api/badge/health-score?project=prowler-cloud-prowler"/></a>
  29. </p>
  30. <p align="center">
  31. <a href="https://github.com/prowler-cloud/prowler/releases"><img alt="Version" src="https://img.shields.io/github/v/release/prowler-cloud/prowler"></a>
  32. <a href="https://github.com/prowler-cloud/prowler/releases"><img alt="Version" src="https://img.shields.io/github/release-date/prowler-cloud/prowler"></a>
  33. <a href="https://github.com/prowler-cloud/prowler"><img alt="Contributors" src="https://img.shields.io/github/contributors-anon/prowler-cloud/prowler"></a>
  34. <a href="https://github.com/prowler-cloud/prowler/issues"><img alt="Issues" src="https://img.shields.io/github/issues/prowler-cloud/prowler"></a>
  35. <a href="https://github.com/prowler-cloud/prowler"><img alt="License" src="https://img.shields.io/github/license/prowler-cloud/prowler"></a>
  36. <a href="https://twitter.com/ToniBlyx"><img alt="Twitter" src="https://img.shields.io/twitter/follow/toniblyx?style=social"></a>
  37. <a href="https://twitter.com/prowlercloud"><img alt="Twitter" src="https://img.shields.io/twitter/follow/prowlercloud?style=social"></a>
  38. </p>
  39. <hr>
  40. <p align="center">
  41. <img align="center" alt="Prowler Cloud demo" src="/docs/img/prowler-cloud.gif" width="100%" height="100%">
  42. </p>
  43. # Description
  44. **Prowler** is the world’s most widely used _Open-Source Cloud Security Platform_ that automates security and compliance across **any cloud environment**. With thousands of ready-to-use security checks, remediation guidance, and compliance frameworks, Prowler is built to _“Secure ANY Cloud at AI Speed”_. Prowler delivers **AI-driven**, **customizable**, and **easy-to-use** assessments, dashboards, reports, and integrations, making cloud security **simple**, **scalable**, and **cost-effective** for organizations of any size.
  45. Prowler includes hundreds of built-in controls to ensure compliance with standards and frameworks, including:
  46. - **Prowler ThreatScore:** Weighted risk prioritization scoring that helps you focus on the most critical security findings first
  47. - **Industry Standards:** CIS, NIST 800, NIST CSF, CISA, and MITRE ATT&CK
  48. - **Regulatory Compliance and Governance:** RBI, FedRAMP, PCI-DSS, and NIS2
  49. - **Frameworks for Sensitive Data and Privacy:** GDPR, HIPAA, and FFIEC
  50. - **Frameworks for Organizational Governance and Quality Control:** SOC2, GXP, and ISO 27001
  51. - **Cloud-Specific Frameworks:** AWS Foundational Technical Review (FTR), AWS Well-Architected Framework, and BSI C5
  52. - **National Security Standards:** ENS (Spanish National Security Scheme) and KISA ISMS-P (Korean)
  53. - **Custom Security Frameworks:** Tailored to your needs
  54. ## Prowler Cloud & Prowler Local Server
  55. [Prowler Cloud](https://cloud.prowler.com/sign-up) and Prowler Local Server, its self-hosted open-source version, are web applications that simplify running Prowler across your cloud provider accounts. They provide a user-friendly interface to visualize the results and streamline your security assessments.
  56. ![Prowler Cloud](docs/images/products/overview.png)
  57. ![Risk Pipeline](docs/images/products/risk-pipeline.png)
  58. ![Threat Map](docs/images/products/threat-map.png)
  59. >For more details, refer to the [Prowler Local Server documentation](https://docs.prowler.com/getting-started/installation/prowler-app)
  60. ## Prowler CLI
  61. ```console
  62. prowler <provider>
  63. ```
  64. ![Prowler CLI Execution](docs/img/short-display.png)
  65. ## Prowler Local Dashboard
  66. ```console
  67. prowler dashboard
  68. ```
  69. ![Prowler Local Dashboard](docs/images/products/dashboard.png)
  70. ## Attack Paths
  71. Attack Paths automatically extends every completed AWS scan with a graph that combines Cartography's cloud inventory with Prowler findings. The feature runs in the API worker after each scan.
  72. Two graph backends are supported as the long-lived sink:
  73. - **Neo4j** (default; the Docker Compose files already ship a `neo4j` service).
  74. - **Amazon Neptune** (cloud-managed; opt-in).
  75. Select the sink with `ATTACK_PATHS_SINK_DATABASE` (`neo4j` or `neptune`; default `neo4j`).
  76. > Note: Cartography ingestion always uses a temporary Neo4j database, regardless of the configured sink. The `NEO4J_*` variables below must remain set even when `ATTACK_PATHS_SINK_DATABASE=neptune`.
  77. ### Neo4j sink
  78. | Variable | Description | Default |
  79. | --- | --- | --- |
  80. | `NEO4J_HOST` | Hostname used by the API containers. | `neo4j` |
  81. | `NEO4J_PORT` | Bolt port exposed by Neo4j. | `7687` |
  82. | `NEO4J_USER` / `NEO4J_PASSWORD` | Credentials with rights to create per-tenant databases. | `neo4j` / `neo4j_password` |
  83. ### Neptune sink
  84. | Variable | Description | Default |
  85. | --- | --- | --- |
  86. | `NEPTUNE_WRITER_ENDPOINT` | Bolt host for the Neptune writer instance. Required when sink is `neptune`. | _empty_ |
  87. | `NEPTUNE_READER_ENDPOINT` | Optional reader endpoint for read-only queries. Falls back to the writer when unset. | _empty_ |
  88. | `NEPTUNE_PORT` | Bolt port exposed by Neptune. | `8182` |
  89. | `AWS_REGION` | Region the Neptune cluster lives in. Required when sink is `neptune`. | _empty_ |
  90. Neptune authenticates with SigV4 using the standard boto3 credential chain. The worker's IAM role (or `AWS_ACCESS_KEY_ID` / `AWS_SECRET_ACCESS_KEY`) supplies the credentials. There is no Neptune password variable.
  91. Every AWS provider scan will enqueue an Attack Paths ingestion job automatically. Other cloud providers will be added in future iterations.
  92. # Prowler at a Glance
  93. > [!Tip]
  94. > For the most accurate and up-to-date information about checks, services, frameworks, and categories, visit [**Prowler Hub**](https://hub.prowler.com).
  95. | Provider | Checks | Services | [Compliance Frameworks](https://docs.prowler.com/user-guide/compliance/tutorials/compliance) | [Categories](https://docs.prowler.com/user-guide/cli/tutorials/misc#categories) | Support | Interface |
  96. |---|---|---|---|---|---|---|
  97. | AWS | 662 | 86 | 50 | 19 | Official | UI, API, CLI |
  98. | Azure | 191 | 22 | 25 | 16 | Official | UI, API, CLI |
  99. | GCP | 110 | 20 | 22 | 12 | Official | UI, API, CLI |
  100. | Kubernetes | 92 | 7 | 11 | 11 | Official | UI, API, CLI |
  101. | GitHub | 24 | 3 | 2 | 5 | Official | UI, API, CLI |
  102. | M365 | 144 | 10 | 10 | 10 | Official | UI, API, CLI |
  103. | OCI | 52 | 14 | 5 | 10 | Official | UI, API, CLI |
  104. | Alibaba Cloud | 63 | 9 | 6 | 9 | Official | UI, API, CLI |
  105. | Cloudflare | 43 | 5 | 3 | 9 | Official | UI, API, CLI |
  106. | IaC | [See `trivy` docs.](https://trivy.dev/latest/docs/coverage/iac/) | N/A | N/A | N/A | Official | UI, API, CLI |
  107. | MongoDB Atlas | 10 | 3 | 1 | 8 | Official | UI, API, CLI |
  108. | LLM | [See `promptfoo` docs.](https://www.promptfoo.dev/docs/red-team/plugins/) | N/A | N/A | N/A | Official | CLI |
  109. | Image | N/A | N/A | N/A | N/A | Official | UI, API, CLI |
  110. | Google Workspace | 65 | 11 | 4 | 6 | Official | UI, API, CLI |
  111. | OpenStack | 34 | 5 | 1 | 9 | Official | UI, API, CLI |
  112. | Vercel | 26 | 6 | 1 | 8 | Official | UI, API, CLI |
  113. | Okta | 29 | 8 | 2 | 2 | Official | UI, API, CLI |
  114. | Linode [Contact us](https://prowler.com/contact) | 10 | 3 | 1 | 4 | Unofficial | CLI |
  115. | Huawei Cloud [Contact us](https://prowler.com/contact) | 25 | 10 | 1 | 6 | Unofficial | CLI |
  116. | E2E Networks [Contact us](https://prowler.com/contact) | 27 | 6 | 0 | 2 | Unofficial | CLI |
  117. | Scaleway [Contact us](https://prowler.com/contact) | 1 | 1 | 1 | 1 | Unofficial | CLI |
  118. | StackIT [Contact us](https://prowler.com/contact) | 8 | 2 | 1 | 3 | Unofficial | CLI |
  119. | NHN | 6 | 2 | 2 | 0 | Unofficial | CLI |
  120. > [!Note]
  121. > The numbers in the table are updated periodically.
  122. > [!Note]
  123. > Use the following commands to list Prowler's available checks, services, compliance frameworks, and categories:
  124. > - `prowler <provider> --list-checks`
  125. > - `prowler <provider> --list-services`
  126. > - `prowler <provider> --list-compliance`
  127. > - `prowler <provider> --list-categories`
  128. # 💻 Installation
  129. ## Prowler Local Server
  130. Prowler Local Server offers flexible installation methods tailored to various environments:
  131. > For detailed instructions on using Prowler Local Server, refer to the [usage guide](https://docs.prowler.com/user-guide/tutorials/prowler-app).
  132. ### Docker Compose
  133. #### Requirements
  134. - `Docker Compose` installed: https://docs.docker.com/compose/install/.
  135. #### Commands
  136. _macOS/Linux:_
  137. ``` console
  138. VERSION=$(curl -s https://api.github.com/repos/prowler-cloud/prowler/releases/latest | jq -r .tag_name)
  139. curl -sLO "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/${VERSION}/docker-compose.yml"
  140. # Environment variables can be customized in the .env file. Using default values in production environments is not recommended.
  141. curl -sLO "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/${VERSION}/.env"
  142. docker compose up -d
  143. ```
  144. _Windows PowerShell:_
  145. ``` powershell
  146. $VERSION = (Invoke-RestMethod -Uri "https://api.github.com/repos/prowler-cloud/prowler/releases/latest").tag_name
  147. Invoke-WebRequest -Uri "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/$VERSION/docker-compose.yml" -OutFile "docker-compose.yml"
  148. # Environment variables can be customized in the .env file. Using default values in production environments is not recommended.
  149. Invoke-WebRequest -Uri "https://raw.githubusercontent.com/prowler-cloud/prowler/refs/tags/$VERSION/.env" -OutFile ".env"
  150. docker compose up -d
  151. ```
  152. > [!WARNING]
  153. > 🔒 For a secure setup, the API auto-generates a unique key pair, `DJANGO_TOKEN_SIGNING_KEY` and `DJANGO_TOKEN_VERIFYING_KEY`, and stores it in `~/.config/prowler-api` (non-container) or the bound Docker volume in `_data/api` (container). Never commit or reuse static/default keys. To rotate keys, delete the stored key files and restart the API.
  154. Once configured, access Prowler Local Server at http://localhost:3000. Sign up using your email and password to get started.
  155. ### Common Issues with Docker Pull Installation
  156. > [!Note]
  157. If you want to use AWS role assumption (e.g., with the "Connect assuming IAM Role" option), you may need to mount your local `.aws` directory into the container as a volume (e.g., `- "${HOME}/.aws:/home/prowler/.aws:ro"`). There are several ways to configure credentials for Docker containers. See the [Troubleshooting](./docs/troubleshooting.mdx) section for more details and examples.
  158. You can find more information in the [Troubleshooting](./docs/troubleshooting.mdx) section.
  159. ### From GitHub
  160. #### Requirements
  161. - `git` installed.
  162. - `uv` installed: [uv installation](https://docs.astral.sh/uv/getting-started/installation/).
  163. - `pnpm` installed: [pnpm installation](https://pnpm.io/installation).
  164. - `Docker Compose` installed: https://docs.docker.com/compose/install/.
  165. #### Commands to run the API
  166. ``` console
  167. git clone https://github.com/prowler-cloud/prowler
  168. cd prowler/api
  169. uv sync
  170. source .venv/bin/activate
  171. set -a
  172. source .env
  173. docker compose up postgres valkey -d
  174. cd src/backend
  175. python manage.py migrate --database admin
  176. gunicorn -c config/guniconf.py config.wsgi:application
  177. ```
  178. > After completing the setup, access the API documentation at http://localhost:8080/api/v1/docs.
  179. #### Commands to run the API Worker
  180. ``` console
  181. git clone https://github.com/prowler-cloud/prowler
  182. cd prowler/api
  183. uv sync
  184. source .venv/bin/activate
  185. set -a
  186. source .env
  187. cd src/backend
  188. python -m celery -A config.celery worker -l info -E
  189. ```
  190. #### Commands to run the API Scheduler
  191. ``` console
  192. git clone https://github.com/prowler-cloud/prowler
  193. cd prowler/api
  194. uv sync
  195. source .venv/bin/activate
  196. set -a
  197. source .env
  198. cd src/backend
  199. python -m celery -A config.celery beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler
  200. ```
  201. #### Commands to run the UI
  202. ``` console
  203. git clone https://github.com/prowler-cloud/prowler
  204. cd prowler/ui
  205. pnpm install
  206. pnpm run build
  207. pnpm start
  208. ```
  209. > Once configured, access Prowler Local Server at http://localhost:3000. Sign up using your email and password to get started.
  210. #### Pre-commit Hooks Setup
  211. Some pre-commit hooks require tools installed on your system:
  212. 1. **Install [TruffleHog](https://github.com/trufflesecurity/trufflehog#install)** (secret scanning) — see the [official installation options](https://github.com/trufflesecurity/trufflehog#install).
  213. 2. **Install [Hadolint](https://github.com/hadolint/hadolint#install)** (Dockerfile linting) — see the [official installation options](https://github.com/hadolint/hadolint#install).
  214. ## Prowler CLI
  215. ### Pip package
  216. 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.14:
  217. ```console
  218. pip install prowler
  219. prowler -v
  220. ```
  221. >For further guidance, refer to [https://docs.prowler.com](https://docs.prowler.com/getting-started/installation/prowler-cli)
  222. ### Containers
  223. #### Available Versions of Prowler CLI
  224. The following versions of Prowler CLI are available, depending on your requirements:
  225. - `latest`: Synchronizes with the `master` branch. Note that this version is not stable.
  226. - `v4-latest`: Synchronizes with the `v4` branch. Note that this version is not stable.
  227. - `v3-latest`: Synchronizes with the `v3` branch. Note that this version is not stable.
  228. - `<x.y.z>` (release): Stable releases corresponding to specific versions. See the [complete list of Prowler releases](https://github.com/prowler-cloud/prowler/releases).
  229. - `stable`: Always points to the latest release.
  230. - `v4-stable`: Always points to the latest release for v4.
  231. - `v3-stable`: Always points to the latest release for v3.
  232. The container images are available here:
  233. - Prowler CLI:
  234. - [DockerHub](https://hub.docker.com/r/prowlercloud/prowler/tags)
  235. - [AWS Public ECR](https://gallery.ecr.aws/prowler-cloud/prowler)
  236. - Prowler Local Server:
  237. - [DockerHub - Prowler UI](https://hub.docker.com/r/prowlercloud/prowler-ui/tags)
  238. - [DockerHub - Prowler API](https://hub.docker.com/r/prowlercloud/prowler-api/tags)
  239. ### From GitHub
  240. Python >=3.10, <3.14 is required with [uv](https://docs.astral.sh/uv/):
  241. ``` console
  242. git clone https://github.com/prowler-cloud/prowler
  243. cd prowler
  244. uv sync
  245. source .venv/bin/activate
  246. python prowler-cli.py -v
  247. ```
  248. > [!IMPORTANT]
  249. > To clone Prowler on Windows, configure Git to support long file paths by running the following command: `git config core.longpaths true`.
  250. # 🛡️ GitHub Action
  251. The official **Prowler GitHub Action** runs Prowler scans in your GitHub workflows using the official [`prowlercloud/prowler`](https://hub.docker.com/r/prowlercloud/prowler) Docker image. Scans run on any [supported provider](https://docs.prowler.com/user-guide/providers/), with optional [`--push-to-cloud`](https://docs.prowler.com/user-guide/tutorials/prowler-import-findings) to send findings to Prowler Cloud and optional SARIF upload so findings show up in the repo's **Security → Code scanning** tab and as inline PR annotations.
  252. ```yaml
  253. name: Prowler IaC Scan
  254. on:
  255. pull_request:
  256. permissions:
  257. contents: read
  258. security-events: write
  259. actions: read
  260. jobs:
  261. prowler:
  262. runs-on: ubuntu-latest
  263. steps:
  264. - uses: actions/checkout@v4
  265. - uses: prowler-cloud/prowler@5.25
  266. with:
  267. provider: iac
  268. output-formats: sarif json-ocsf
  269. upload-sarif: true
  270. flags: --severity critical high
  271. ```
  272. Full configuration, per-provider authentication, and SARIF examples: [Prowler GitHub Action tutorial](docs/user-guide/tutorials/prowler-app-github-action.mdx). Marketplace listing: [Prowler Security Scan](https://github.com/marketplace/actions/prowler-security-scan).
  273. # ✏️ High level architecture
  274. ## Prowler Local Server
  275. **Prowler Local Server** is composed of four key components:
  276. - **Prowler UI**: A web-based interface, built with Next.js, providing a user-friendly experience for executing Prowler scans and visualizing results.
  277. - **Prowler API**: A backend service, developed with Django REST Framework, responsible for running Prowler scans and storing the generated results.
  278. - **Prowler SDK**: A Python SDK designed to extend the functionality of the Prowler CLI for advanced capabilities.
  279. - **Prowler MCP Server**: A Model Context Protocol server that provides AI tools for Lighthouse, the AI-powered security assistant. This is a critical dependency for Lighthouse functionality.
  280. ```mermaid
  281. flowchart TB
  282. user([User / Security Team])
  283. cli([Prowler CLI])
  284. subgraph APP["Prowler Local Server"]
  285. ui["Prowler UI<br/>(Next.js)"]
  286. api["Prowler API<br/>(Django REST Framework)"]
  287. worker["API Worker<br/>(Celery)"]
  288. beat["API Scheduler<br/>(Celery Beat)"]
  289. mcp["Prowler MCP Server<br/>(Lighthouse AI tools)"]
  290. end
  291. sdk["Prowler SDK<br/>(Python)"]
  292. subgraph DATA["Data Layer"]
  293. pg[("PostgreSQL")]
  294. valkey[("Valkey / Redis")]
  295. neo4j[("Neo4j")]
  296. end
  297. providers["Providers"]
  298. user --> ui
  299. user --> cli
  300. ui -->|REST| api
  301. ui -->|MCP HTTP| mcp
  302. mcp -->|REST| api
  303. api --> pg
  304. api --> valkey
  305. beat -->|enqueue jobs| valkey
  306. valkey -->|dispatch| worker
  307. worker --> pg
  308. worker -->|Attack Paths| neo4j
  309. worker -->|invokes| sdk
  310. cli --> sdk
  311. sdk --> providers
  312. ```
  313. <!-- Diagram source: docs/images/products/prowler-app-architecture.mmd — keep this inline block, the docs page getting-started/products/prowler-app.mdx, and the .mmd file in sync. -->
  314. ## Prowler CLI
  315. ### Running Prowler
  316. Prowler can be executed across various environments, offering flexibility to meet your needs. It can be run from:
  317. - Your own workstation
  318. - A Kubernetes Job
  319. - Google Compute Engine
  320. - Azure Virtual Machines (VMs)
  321. - Amazon EC2 instances
  322. - AWS Fargate or other container platforms
  323. - CloudShell
  324. And many more environments.
  325. ![Architecture](docs/img/architecture.png)
  326. # 🤖 AI Skills for Development
  327. Prowler includes a comprehensive set of **AI Skills** that help AI coding assistants understand Prowler's codebase patterns and conventions.
  328. ## What are AI Skills?
  329. Skills are structured instructions that give AI assistants the context they need to write code that follows Prowler's standards. They include:
  330. - **Coding patterns** for each component (SDK, API, UI, MCP Server)
  331. - **Testing conventions** (pytest, Playwright)
  332. - **Architecture guidelines** (Clean Architecture, RLS patterns)
  333. - **Framework-specific rules** (React 19, Next.js 15, Django DRF, Tailwind 4)
  334. ## Available Skills
  335. | Category | Skills |
  336. |----------|--------|
  337. | **Generic** | `typescript`, `react-19`, `nextjs-15`, `tailwind-4`, `playwright`, `pytest`, `django-drf`, `zod-4`, `zustand-5`, `ai-sdk-5` |
  338. | **Prowler** | `prowler`, `prowler-api`, `prowler-ui`, `prowler-mcp`, `prowler-sdk-check`, `prowler-test-ui`, `prowler-test-api`, `prowler-test-sdk`, `prowler-compliance`, `prowler-provider`, `prowler-pr`, `prowler-docs` |
  339. ## Setup
  340. ```bash
  341. ./skills/setup.sh
  342. ```
  343. This configures skills for AI coding assistants that follow the [agentskills.io](https://agentskills.io) standard:
  344. | Tool | Configuration |
  345. |------|---------------|
  346. | **Claude Code** | `.claude/skills/` (symlink) |
  347. | **OpenCode** | `.claude/skills/` (symlink) |
  348. | **Codex (OpenAI)** | `.codex/skills/` (symlink) |
  349. | **GitHub Copilot** | `.github/skills/` (symlink) |
  350. | **Gemini CLI** | `.gemini/skills/` (symlink) |
  351. > **Note:** Restart your AI coding assistant after running setup to load the skills.
  352. > Gemini CLI requires `experimental.skills` enabled in settings.
  353. # 📖 Documentation
  354. For installation instructions, usage details, tutorials, and the Developer Guide, visit https://docs.prowler.com/
  355. # 📃 License
  356. Prowler is licensed under the Apache License 2.0.
  357. A copy of the License is available at <http://www.apache.org/licenses/LICENSE-2.0>

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.