Getting Started with AuditKit

Prerequisites

• Cloud account access (AWS, Azure, or GCP)
• Cloud CLI installed and configured
• 5 minutes

Installation

Option 1: Download Binary (Fastest)

1. Go to Releases
2. Download binary for your OS (Linux, macOS, Windows)
3. Make it executable: chmod +x auditkit
4. Run: ./auditkit scan

Option 2: Build from Source

git clone https://github.com/guardian-nexus/auditkit
cd auditkit/scanner
go build ./cmd/auditkit
./auditkit scan

Your First Scan

# 1. Configure credentials
aws configure

# 2. Run scan
./auditkit scan -provider aws -framework soc2

# 3. Generate PDF
./auditkit scan -provider aws -framework soc2 -format pdf -output report.pdf

# 1. Login to Azure
az login
export AZURE_SUBSCRIPTION_ID="your-subscription-id"

# 2. Run scan
./auditkit scan -provider azure -framework soc2

# 3. Generate PDF
./auditkit scan -provider azure -framework soc2 -format pdf -output report.pdf

# 1. Login to GCP
gcloud auth application-default login
export GOOGLE_CLOUD_PROJECT=your-project-id

# 2. Run scan
./auditkit scan -provider gcp -framework soc2

# 3. Generate PDF
./auditkit scan -provider gcp -framework soc2 -format pdf -output report.pdf

Understanding Your Results

Terminal Output

AuditKit SOC2 Compliance Scan Results
=====================================
AWS Account: 123456789012
Scan Time: 2025-10-19 14:30:00

Compliance Score: 72.5%
Controls Passed: 46/64

Critical Issues: 3 (FIX IMMEDIATELY)
High Priority: 6
Medium Priority: 4

CRITICAL - Fix These NOW:
[FAIL] CC6.6 - User MFA Enforcement
[FAIL] CC6.2 - S3 Bucket Public Access
[FAIL] CC6.1 - IAM Key Rotation

What this means:

• Compliance Score: Percentage of passing controls
• Critical Issues: Security gaps requiring immediate attention
• Each failed control shows: What's wrong and how to fix it

Report Formats

PDF Report - For auditors and management

./auditkit scan -format pdf -output report.pdf

HTML Report - Interactive, great for teams

./auditkit scan -format html -output report.html

JSON Report - For automation/CI/CD

./auditkit scan -format json -output results.json

Next Steps

1. Fix Critical Issues

AuditKit shows exact commands to fix each issue:

# Generate fix script
./auditkit fix -output fixes.sh

# Review the script
cat fixes.sh

# Run fixes (review first!)
bash fixes.sh

2. Track Your Progress

# Show improvement over time
./auditkit progress

# Compare last two scans
./auditkit compare

3. Scan Other Frameworks

# PCI-DSS
./auditkit scan -framework pci

# CMMC Level 1
./auditkit scan -framework cmmc

# NIST 800-53
./auditkit scan -framework 800-53

# All frameworks
./auditkit scan -framework all

Common Use Cases

# Scan all providers
./auditkit scan -provider aws -framework soc2 -output aws.json
./auditkit scan -provider azure -framework soc2 -output azure.json
./auditkit scan -provider gcp -framework soc2 -output gcp.json

Troubleshooting

"Error: AWS credentials not configured"

Solution:

aws configure
# Enter your AWS Access Key ID and Secret Access Key

AWS Setup Guide →

"Error: Azure subscription not found"

Solution:

az login
az account list  # Find your subscription ID
export AZURE_SUBSCRIPTION_ID="your-sub-id"

Azure Setup Guide →

"Error: GCP project not found"

Solution:

gcloud auth application-default login
gcloud projects list  # Find your project ID
export GOOGLE_CLOUD_PROJECT=your-project-id

GCP Setup Guide →

"Compliance score is very low (< 30%)"

Common cause: Security services not enabled

Solution: Enable these first:

• AWS: GuardDuty, Config, CloudTrail, Security Hub
• Azure: Defender for Cloud, Azure Policy, Activity Logs
• GCP: Security Command Center, Cloud Logging, Cloud KMS

Then re-scan.

What's Next?