docs(fixer): add alias to prowler fixer -> remediations (#3926)

This commit is contained in:
Pedro Martín
2024-05-06 11:10:20 +02:00
committed by GitHub
parent 2fbb47d839
commit 3162f6cd92
4 changed files with 11 additions and 4 deletions
+3 -3
View File
@@ -1,4 +1,4 @@
# Prowler Fixer
# Prowler Fixer (remediation)
Prowler allows you to fix some of the failed findings it identifies. You can use the `--fixer` flag to run the fixes that are available for the checks that failed.
```sh
@@ -8,10 +8,10 @@ prowler <provider> -c <check_to_fix_1> <check_to_fix_2> ... --fixer
<img src="../img/fixer.png">
???+ note
You can see all the available fixes for each provider with the `--list-fixers` flag.
You can see all the available fixes for each provider with the `--list-remediations` or `--list-fixers flag.
```sh
prowler <provider> --list-fixer
prowler <provider> --list-fixers
```
## Writing a Fixer
+1 -1
View File
@@ -53,7 +53,7 @@ nav:
- Reporting: tutorials/reporting.md
- Compliance: tutorials/compliance.md
- Dashboard: tutorials/dashboard.md
- Fixer: tutorials/fixer.md
- Fixer (remediations): tutorials/fixer.md
- Quick Inventory: tutorials/quick-inventory.md
- Slack Integration: tutorials/integrations.md
- Configuration File: tutorials/configuration_file.md
+1
View File
@@ -319,6 +319,7 @@ Detailed documentation at https://docs.prowler.com
list_group.add_argument(
"--list-fixer",
"--list-fixers",
"--list-remediations",
action="store_true",
help="List fixers available for the provider",
)
+6
View File
@@ -711,6 +711,12 @@ class Test_Parser:
parsed = self.parser.parse(command)
assert parsed.list_fixer
def test_list_checks_parser_list_remediations(self):
argument = "--list-remediations"
command = [prowler_command, argument]
parsed = self.parser.parse(command)
assert parsed.list_fixer
def test_list_checks_parser_list_compliance_requirements_no_arguments(self):
argument = "--list-compliance-requirements"
command = [prowler_command, argument]