📚 Usage Guide

Complete reference for using the CIS Benchmark Compliance Checker

Installation

# Clone repository
git clone https://github.com/SiteQ8/CIS-Benchmark-Compliance-Checker.git
cd CIS-Benchmark-Compliance-Checker

# Install dependencies
pip install -r requirements.txt

# Install package
python setup.py install

CLI Commands

Audit Command

Run compliance audits against CIS benchmarks.

# Basic audit
python -m cis_checker audit

# Specify OS and level
python -m cis_checker audit --os ubuntu --level 1

# Generate multiple formats
python -m cis_checker audit --format html --format json

Remediate Command

Apply fixes for non-compliant configurations.

# Dry run (preview changes)
python -m cis_checker remediate --dry-run

# Apply with backup
python -m cis_checker remediate --profile ubuntu_22_04 --backup

# Specific checks only
python -m cis_checker remediate --checks 1.1.1,2.3.1

Report Command

Generate reports from audit results.

# Generate HTML report
python -m cis_checker report --input results.json --format html

# Generate CSV report
python -m cis_checker report --input results.json --format csv

Configuration

CIS benchmark profiles are stored in JSON format in the configs/ directory.

← Back to Home