diff --git a/README.md b/README.md index 4e5cef07..643cace7 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ This script has been written in bash using AWS-CLI and it works in Linux and OSX 1. If you want to save your report for later analysis: ```sh - ./prowler > prowler-report.txt + ./prowler -M mono > prowler-report.txt ``` or if you want a coloured HTML report do: @@ -127,6 +127,11 @@ This script has been written in bash using AWS-CLI and it works in Linux and OSX ```sh ./prowler -M csv > output.psv ``` + or json formatted output using jq, do: + + ```sh + ./prowler -M json > prowler-output.json + ``` or save your report in a S3 bucket: @@ -166,7 +171,7 @@ This script has been written in bash using AWS-CLI and it works in Linux and OSX -f specify an AWS region to run checks against (i.e.: us-west-1) -m specify the maximum number of items to return for long-running requests (default: 100) - -M output mode: text (default), mono, csv (separator is ,; data is on stdout; progress on stderr) + -M output mode: text (default), mono, json, csv (separator is ,; data is on stdout; progress on stderr) -k keep the credential report -n show check numbers to sort easier (i.e.: 1.01 instead of 1.1) @@ -176,7 +181,7 @@ This script has been written in bash using AWS-CLI and it works in Linux and OSX -h this help ``` -## Fix every FAIL +## How to fix every FAIL Check your report and fix the issues following all specific guidelines per check in diff --git a/prowler b/prowler index ed65cdd6..b5fcbae5 100755 --- a/prowler +++ b/prowler @@ -63,7 +63,7 @@ USAGE: -f specify an AWS region to run checks against (i.e.: us-west-1) -m specify the maximum number of items to return for long-running requests (default: 100) - -M output mode: text (default), mono, csv (separator is ","; data is on stdout; progress on stderr) + -M output mode: text (default), mono, json, csv (separator is ","; data is on stdout; progress on stderr) -k keep the credential report -n show check numbers to sort easier (i.e.: 1.01 instead of 1.1)