Components
| Component |
Stack |
Location |
| SDK |
Python 3.9+, Poetry |
prowler/ |
| API |
Django 5.1, DRF, Celery |
api/ |
| UI |
Next.js 15, React 19, Tailwind 4 |
ui/ |
| MCP |
FastMCP 2.13.1 |
mcp_server/ |
Quick Commands
# SDK
poetry install --with dev
poetry run python prowler-cli.py aws --check check_name
poetry run pytest tests/
# API
cd api && poetry run python src/backend/manage.py runserver
cd api && poetry run pytest
# UI
cd ui && pnpm run dev
cd ui && pnpm run healthcheck
# MCP
cd mcp_server && uv run prowler-mcp
# Full Stack
docker-compose up -d
Providers
AWS, Azure, GCP, Kubernetes, GitHub, M365, OCI, AlibabaCloud, Cloudflare, MongoDB Atlas, NHN, LLM, IaC
Commit Style
feat:, fix:, docs:, chore:, perf:, refactor:, test:
Related Skills
prowler-sdk-check - Create security checksprowler-api - Django/DRF patternsprowler-ui - Next.js/React patternsprowler-mcp - MCP server toolsprowler-test - Testing patterns
Resources
- Documentation: See references/ for links to local developer guide
1---2name: prowler3description: Main entry point for Prowler development - quick reference for all components. Trigger: General Prowler development questions, project overview, component navigation (NOT PR CI gates or GitHub Actions workflows).4license: Apache-2.05---6
7## Components
8
9| Component | Stack | Location |
10|-----------|-------|----------|
11| SDK | Python 3.9+, Poetry | `prowler/` |
12| API | Django 5.1, DRF, Celery | `api/` |
13| UI | Next.js 15, React 19, Tailwind 4 | `ui/` |
14| MCP | FastMCP 2.13.1 | `mcp_server/` |
15
16## Quick Commands
17
18```bash
19# SDK
20poetry install --with dev
21poetry run python prowler-cli.py aws --check check_name
22poetry run pytest tests/
23
24# API
25cd api && poetry run python src/backend/manage.py runserver
26cd api && poetry run pytest
27
28# UI
29cd ui && pnpm run dev
30cd ui && pnpm run healthcheck
31
32# MCP
33cd mcp_server && uv run prowler-mcp
34
35# Full Stack
36docker-compose up -d
37```
38
39## Providers
40
41AWS, Azure, GCP, Kubernetes, GitHub, M365, OCI, AlibabaCloud, Cloudflare, MongoDB Atlas, NHN, LLM, IaC
42
43## Commit Style
44
45`feat:`, `fix:`, `docs:`, `chore:`, `perf:`, `refactor:`, `test:`
46
47## Related Skills
48
49- `prowler-sdk-check` - Create security checks
50- `prowler-api` - Django/DRF patterns
51- `prowler-ui` - Next.js/React patterns
52- `prowler-mcp` - MCP server tools
53- `prowler-test` - Testing patterns
54
55## Resources
56
57- **Documentation**: See [references/](references/) for links to local developer guide
majiayu000