prowler-cloud / prowler
Prowler is the world’s most widely used open-source cloud security platform that automates security and compliance across any cloud environment.
AI Architecture Analysis
This repository is indexed by RepoMind. By analyzing prowler-cloud/prowler in our AI interface, you can instantly generate complete architecture diagrams, visualize control flows, and perform automated security audits across the entire codebase.
Our Agentic Context Augmented Generation (Agentic CAG) engine loads full source files into context, avoiding the fragmentation of traditional RAG systems. Ask questions about the architecture, dependencies, or specific features to see it in action.
Embed this Badge
Showcase RepoMind's analysis directly in your repository's README.
Repository Summary (README)
PreviewDescription
Prowler is the world’s most widely used open-source cloud security platform that automates security and compliance across any cloud environment. With hundreds 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.
Prowler includes hundreds of built-in controls to ensure compliance with standards and frameworks, including:
- Prowler ThreatScore: Weighted risk prioritization scoring that helps you focus on the most critical security findings first
- Industry Standards: CIS, NIST 800, NIST CSF, CISA, and MITRE ATT&CK
- Regulatory Compliance and Governance: RBI, FedRAMP, PCI-DSS, and NIS2
- Frameworks for Sensitive Data and Privacy: GDPR, HIPAA, and FFIEC
- Frameworks for Organizational Governance and Quality Control: SOC2, GXP, and ISO 27001
- Cloud-Specific Frameworks: AWS Foundational Technical Review (FTR), AWS Well-Architected Framework, and BSI C5
- National Security Standards: ENS (Spanish National Security Scheme) and KISA ISMS-P (Korean)
- Custom Security Frameworks: Tailored to your needs
Prowler App / Prowler Cloud
Prowler App / Prowler Cloud is a web-based application that simplifies running Prowler across your cloud provider accounts. It provides a user-friendly interface to visualize the results and streamline your security assessments.
For more details, refer to the Prowler App Documentation
Prowler CLI
prowler <provider>
Prowler Dashboard
prowler dashboard
Attack Paths
Attack Paths automatically extends every completed AWS scan with a Neo4j graph that combines Cartography's cloud inventory with Prowler findings. The feature runs in the API worker after each scan and therefore requires:
-
An accessible Neo4j instance (the Docker Compose files already ships a
neo4jservice). -
The following environment variables so Django and Celery can connect:
Variable Description Default NEO4J_HOSTHostname used by the API containers. neo4jNEO4J_PORTBolt port exposed by Neo4j. 7687NEO4J_USER/NEO4J_PASSWORDCredentials with rights to create per-tenant databases. neo4j/neo4j_password
Every AWS provider scan will enqueue an Attack Paths ingestion job automatically. Other cloud providers will be added in future iterations.
Prowler at a Glance
[!Tip] For the most accurate and up-to-date information about checks, services, frameworks, and categories, visit Prowler Hub.
| Provider | Checks | Services | Compliance Frameworks | Categories | Support | Interface |
|---|---|---|---|---|---|---|
| AWS | 572 | 83 | 41 | 17 | Official | UI, API, CLI |
| Azure | 165 | 20 | 18 | 13 | Official | UI, API, CLI |
| GCP | 100 | 13 | 15 | 11 | Official | UI, API, CLI |
| Kubernetes | 83 | 7 | 7 | 9 | Official | UI, API, CLI |
| GitHub | 21 | 2 | 1 | 2 | Official | UI, API, CLI |
| M365 | 75 | 7 | 4 | 4 | Official | UI, API, CLI |
| OCI | 51 | 13 | 3 | 12 | Official | UI, API, CLI |
| Alibaba Cloud | 61 | 9 | 3 | 9 | Official | UI, API, CLI |
| Cloudflare | 29 | 2 | 0 | 5 | Official | CLI, API |
| IaC | See trivy docs. | N/A | N/A | N/A | Official | UI, API, CLI |
| MongoDB Atlas | 10 | 3 | 0 | 3 | Official | UI, API, CLI |
| LLM | See promptfoo docs. | N/A | N/A | N/A | Official | CLI |
| OpenStack | 1 | 1 | 0 | 2 | Official | CLI |
| NHN | 6 | 2 | 1 | 0 | Unofficial | CLI |
[!Note] The numbers in the table are updated periodically.
[!Note] Use the following commands to list Prowler's available checks, services, compliance frameworks, and categories:
prowler <provider> --list-checksprowler <provider> --list-servicesprowler <provider> --list-complianceprowler <provider> --list-categories
💻 Installation
Prowler App
Prowler App offers flexible installation methods tailored to various environments:
For detailed instructions on using Prowler App, refer to the Prowler App Usage Guide.
Docker Compose
Requirements
Docker Composeinstalled: https://docs.docker.com/compose/install/.
Commands
curl -LO https://raw.githubusercontent.com/prowler-cloud/prowler/refs/heads/master/docker-compose.yml
curl -LO https://raw.githubusercontent.com/prowler-cloud/prowler/refs/heads/master/.env
docker compose up -d
Containers are built for
linux/amd64.
Configuring Your Workstation for Prowler App
If your workstation's architecture is incompatible, you can resolve this by:
- Setting the environment variable:
DOCKER_DEFAULT_PLATFORM=linux/amd64 - Using the following flag in your Docker command:
--platform linux/amd64
Once configured, access the Prowler App 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
.awsdirectory 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 section for more details and examples.
You can find more information in the Troubleshooting section.
From GitHub
Requirements
gitinstalled.poetryv2 installed: poetry installation.pnpminstalled: pnpm installation.Docker Composeinstalled: https://docs.docker.com/compose/install/.
Commands to run the API
git clone https://github.com/prowler-cloud/prowler
cd prowler/api
poetry install
eval $(poetry env 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
[!IMPORTANT] As of Poetry v2.0.0, the
poetry shellcommand has been deprecated. Usepoetry env activateinstead for environment activation.If your Poetry version is below v2.0.0, continue using
poetry shellto activate your environment. For further guidance, refer to the Poetry Environment Activation Guide https://python-poetry.org/docs/managing-environments/#activating-the-environment.
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
poetry install
eval $(poetry env 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
poetry install
eval $(poetry env 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
Once configured, access the Prowler App at http://localhost:3000. Sign up using your email and password to get started.
Prowler CLI
Pip package
Prowler CLI is available as a project in PyPI. Consequently, it can be installed using pip with Python >3.9.1, <3.13:
pip install prowler
prowler -v
For further guidance, refer to https://docs.prowler.com
Containers
Available Versions of Prowler CLI
The following versions of Prowler CLI are available, depending on your requirements:
latest: Synchronizes with themasterbranch. Note that this version is not stable.v4-latest: Synchronizes with thev4branch. Note that this version is not stable.v3-latest: Synchronizes with thev3branch. Note that this version is not stable.<x.y.z>(release): Stable releases corresponding to specific versions. You can find the complete list of releases here.stable: Always points to the latest release.v4-stable: Always points to the latest release for v4.v3-stable: Always points to the latest release for v3.
The container images are available here:
- Prowler CLI:
- Prowler App:
From GitHub
Python >3.9.1, <3.13 is required with pip and Poetry:
git clone https://github.com/prowler-cloud/prowler
cd prowler
eval $(poetry env activate)
poetry install
python prowler-cli.py -v
[!IMPORTANT] To clone Prowler on Windows, configure Git to support long file paths by running the following command:
git config core.longpaths true.
[!IMPORTANT] As of Poetry v2.0.0, the
poetry shellcommand has been deprecated. Usepoetry env activateinstead for environment activation.If your Poetry version is below v2.0.0, continue using
poetry shellto activate your environment. For further guidance, refer to the Poetry Environment Activation Guide https://python-poetry.org/docs/managing-environments/#activating-the-environment.
✏️ High level architecture
Prowler App
Prowler App is composed of four key components:
- Prowler UI: A web-based interface, built with Next.js, providing a user-friendly experience for executing Prowler scans and visualizing results.
- Prowler API: A backend service, developed with Django REST Framework, responsible for running Prowler scans and storing the generated results.
- Prowler SDK: A Python SDK designed to extend the functionality of the Prowler CLI for advanced capabilities.
- 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.
Prowler CLI
Running Prowler
Prowler can be executed across various environments, offering flexibility to meet your needs. It can be run from:
-
Your own workstation
-
A Kubernetes Job
-
Google Compute Engine
-
Azure Virtual Machines (VMs)
-
Amazon EC2 instances
-
AWS Fargate or other container platforms
-
CloudShell
And many more environments.
🤖 AI Skills for Development
Prowler includes a comprehensive set of AI Skills that help AI coding assistants understand Prowler's codebase patterns and conventions.
What are AI Skills?
Skills are structured instructions that give AI assistants the context they need to write code that follows Prowler's standards. They include:
- Coding patterns for each component (SDK, API, UI, MCP Server)
- Testing conventions (pytest, Playwright)
- Architecture guidelines (Clean Architecture, RLS patterns)
- Framework-specific rules (React 19, Next.js 15, Django DRF, Tailwind 4)
Available Skills
| Category | Skills |
|---|---|
| Generic | typescript, react-19, nextjs-15, tailwind-4, playwright, pytest, django-drf, zod-4, zustand-5, ai-sdk-5 |
| 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 |
Setup
./skills/setup.sh
This configures skills for AI coding assistants that follow the agentskills.io standard:
| Tool | Configuration |
|---|---|
| Claude Code | .claude/skills/ (symlink) |
| OpenCode | .claude/skills/ (symlink) |
| Codex (OpenAI) | .codex/skills/ (symlink) |
| GitHub Copilot | .github/skills/ (symlink) |
| Gemini CLI | .gemini/skills/ (symlink) |
Note: Restart your AI coding assistant after running setup to load the skills. Gemini CLI requires
experimental.skillsenabled in settings.
📖 Documentation
For installation instructions, usage details, tutorials, and the Developer Guide, visit https://docs.prowler.com/
📃 License
Prowler is licensed under the Apache License 2.0.
A copy of the License is available at http://www.apache.org/licenses/LICENSE-2.0