docs: 📝 reformat cli argument reference

This commit is contained in:
Dan Brodjieski
2025-06-16 12:57:31 -04:00
committed by GitHub
parent 28d0c54f99
commit c2e3b6d6c0

View File

@@ -65,16 +65,21 @@ Thu Jan 21 15:09:41 UTC 2021 auth_smartcard_enforce has an exemption (Reason: Br
**💡 TIP**\
To add a custom reference in front of the rule in the `{baseline}_baseline.log` use the `-r` flag along with the custom reference **(case sensitive)** when running the `generate_guidance.py` script.
Compliance Script Command Line Argument Reference
## Compliance Script Command Line Argument Reference
|Argument|Description|
|-------|---|
|--check|`optional` Run the compliance checks without interaction|
|--fix|`optional` Run the remediation commands without interaction|
|--cfc|`optional` Runs a check, fix, check without interaction|
|--stats|`optional` Display the statistics from last compliance check|
|--compliant|`optional` Reports the number of compliant checks|
|--non_compliant|`optional` Reports the number of non compliant checks|
|--reset|`optional` Clear out all results for current baseline|
|--reset-all|`optional` Clear out all results for ALL mSCP baselines|
|--quiet=\<value\>|`optional`&ensp;`1`: show only failed and exempted checks in output\\&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;&ensp;`2`: show minimal output|
```
./mscp_compliance.sh Usage
./mscp_compliance.sh [--check] [--fix] [--cfc] [--stats] [--compliant] [--non_compliant] [--reset] [--reset-all] [--quiet=<value>]
Optional parameters:
--check : run the compliance checks without interaction
--fix : run the remediation commands without interaction
--cfc : runs a check, fix, check without interaction
--stats : display the statistics from last compliance check
--compliant : reports the number of compliant checks
--non_compliant : reports the number of non_compliant checks
--reset : clear out all results for current baseline
--reset-all : clear out all results for ALL MSCP baselines
--quiet=<value> : 1 - show only failed and exempted checks in output
2 - show minimal output
```