Skip to content

Commit 219b780

Browse files
committed
docs: πŸ“ added info on zsh
1 parent c2e3b6d commit 219b780

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

β€Ždocs/src/content/docs/guides/how-to/compliance-script.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Compliance Script
33
description: A compliance-script reference.
44
---
55

6-
Adding the `-s` flag to the `generate-guidance.py` script will generate a compliance script, which can be used to check/fix a system.
6+
Adding the `-s` flag to the `generate-guidance.py` script will generate a compliance script, written for Z Shell (zsh), which can be used to check/fix a system.
77

88
```
99
➜ macos_security git:(sequoia) ./scripts/generate_guidance.py -s baselines/800-53r5_moderate.yaml
@@ -28,7 +28,7 @@ When generating the compliance script a `org.{baseline}.audit.plist` will be cre
2828

2929
The `{baseline}_compliance.sh` script can run interactively or with the --check/--fix/--cfc flags. To run the script interactively run the following command:
3030

31-
```
31+
```zsh
3232
sudo ./build/800-53r5_moderate/800-53r5_moderate_compliance.sh
3333

3434
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -67,7 +67,10 @@ To add a custom reference in front of the rule in the `{baseline}_baseline.log`
6767

6868
## Compliance Script Command Line Argument Reference
6969

70-
```
70+
**πŸ“Œ NOTE**\
71+
The compliance script expects to be run in a Z Shell (zsh), trying to execute the script using `sh` or `bash` will result in errors.
72+
73+
```zsh
7174
./mscp_compliance.sh Usage
7275
./mscp_compliance.sh [--check] [--fix] [--cfc] [--stats] [--compliant] [--non_compliant] [--reset] [--reset-all] [--quiet=<value>]
7376

0 commit comments

Comments
Β (0)