Quick Guide

If you’re new to the project, start with this Quick Guide for a high-level overview of the workflow. After reviewing these steps, check out each step’s corresponding “How To” section in the documentation menu. These sections explain in more detail what each step does, why it’s important, and what outputs to expect.

This quick guide provides a high-level overview of the steps required to generate all files with the macOS Security Compliance Project.

Note

For details about each step, check out the corresponding menu item and the “What are…” section for that topic to understand its purpose and outputs.

1. 1. Prepare Your Environment
   • Ensure all prerequisites are installed (Python, required modules, etc.).
   • Download or clone the repository.

   Note

   See Getting Started for setup details.

2. 2. Verify and Select the Correct Branch
   • Checkout the branch that matches your target OS version (e.g., sequoia).

   Caution

   Always use the branch matching your target OS version. Do not use the main branch for workflow or development.
3. 3. Generate a Baseline
   • Use generate_baseline.py to create a baseline YAML file for your compliance needs.
   • Optional Tailor the baseline to your organization using the -t flag.

   Note

   See How To Generate Baseline for details.

4. 4. Personalize: Customize RulesOptional
   • Customize rules by modifying or adding rule YAML files in the custom folder as needed.

   Note

   See Customization for more information.

5. 5. Generate Guidance DocumentationOptional
   • Run generate_guidance.py to create human-readable guidance (AsciiDoc, HTML, PDF, etc.).

   Note

   See How To Generate Guidance for details.

6. 6. Generate Configuration Profiles
   • Add the -p flag to generate_guidance.py to generate configuration profiles for supported rules.

   Note

   See How To Generate Configuration Profiles for details.

7. 7. Generate DDM Content
   • Add the -D flag to generate_guidance.py to generate Declarative Device Management (DDM) components.

   Note

   See How To Generate DDM Components for details.

8. 8. Generate Compliance Scripts
   • Add the -s flag to generate_guidance.py to generate a compliance script for automated checking and remediation.

   Note

   See How To Generate Compliance Scripts for details.

9. 9. Make ExemptionsOptional
   • Customize or exempt specific rules as needed for your environment.

   Note

   See the exemptions folder or the project’s wiki for customization options.

Tip

Need help?
If you encounter issues, check the Guides section, review the FAQ, or visit the project’s wiki for troubleshooting and community support.