mcpField
P
prowler-readme-table

prowler-readme-table

github.com/prowler-cloudDocuments15.1k52 installsUpdated today
Repository

About prowler-readme-table

prowler-readme-table is a skill for maintaining the “Prowler at a Glance” table in the root README.md. It requires collecting provider metrics through the CLI and updating the table in the specified format.

Key features

  1. 01Collect provider metrics through the CLI
  2. 02Gather checks, services, compliance, and categories
  3. 03Map CLI names to table display names
  4. 04Follow table format and special-row rules
  5. 05Verify the CLI before collecting data

Use cases

  1. 01Refresh Prowler overview data in the README
  2. 02Update metrics for multiple providers consistently

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/prowler-cloud/prowler --skill prowler-readme-table

After installing, type/prowler-readme-tablein Claude Code to confirm it loaded.

Details

From the project README

When to Use

Use this skill when updating the Prowler at a Glance table in the root README.md. This table tracks the number of checks, services, compliance frameworks, and categories for each supported provider.

Procedure

Step 1: Collect Stats via CLI

Run the following command for each provider and each metric:

python3 prowler-cli.py <provider> --list-<metric>

Providers: aws, azure, gcp, kubernetes, github, m365, oraclecloud, alibabacloud, cloudflare, mongodbatlas, openstack, nhn

Metrics: checks, services, compliance, categories

The CLI output ends with a summary line like:

There are 572 available checks.
There is 1 available Compliance Framework.

Extract the number from the summary line. Note that singular results use "There is" instead of "There are".

Step 2: Batch Extraction

Use this one-liner to collect all stats at once (handles both singular and plural output):

for provider in aws azure gcp kubernetes github m365 oraclecloud alibabacloud cloudflare mongodbatlas openstack nhn; do
  for metric in checks services compliance categories; do
    result=$(python3 prowler-cli.py $provider --list-$metric 2>&1 | sed -n 's/.*There \(are\|is\) .*\x1b\[33m\([0-9]*\)\x1b\[0m.*/\2/p')
    echo "$provider $metric: $result"
  done
done
Step 3: Update the Table

Edit the table in README.md (located in the # Prowler at a Glance section) with the collected numbers.

Table format:

| Provider | Checks | Services | [Compliance Frameworks](...) | [Categories](...) | Support | Interface |
|---|---|---|---|---|---|---|
| AWS | 572 | 83 | 41 | 17 | Official | UI, API, CLI |
Provider Name Mapping
CLI ProviderTable Display Name
awsAWS
azureAzure
gcpGCP
kubernetesKubernetes
githubGitHub
m365M365
oraclecloudOCI
alibabacloudAlibaba Cloud
cloudflareCloudflare
mongodbatlasMongoDB Atlas
openstackOpenStack
nhnNHN
Special Rows (No CLI stats)

These providers delegate to external tools and do NOT use CLI stats:

ProviderChecks ColumnServicesComplianceCategories
IaC[See trivy docs.](https://trivy.dev/latest/docs/coverage/iac/)N/AN/AN/A
LLM[See promptfoo docs.](https://www.promptfoo.dev/docs/red-team/plugins/)N/AN/AN/A
Support and Interface Columns
  • Support: Official for all providers except NHN which is Unofficial
  • Interface: Most providers use UI, API, CLI. Exceptions with CLI only: Cloudflare, OpenStack, NHN, LLM

Rules

  • ALWAYS use the CLI (python3 prowler-cli.py) to obtain numbers. Do NOT count files manually.
  • NEVER commit changes unless explicitly asked.
  • NEVER modify the IaC or LLM rows (they link to external docs).
  • Verify the CLI is working by running one provider first before batch-processing all.

Resources

  • CLI entry point: prowler-cli.py in the repository root
  • Table location: README.md, section # Prowler at a Glance (around line 100)

Comments

Markdown supported