Installation Guide

System Requirements

Operating Systems:

• Linux (any modern distribution)
• macOS (10.15 Catalina or newer)
• Windows (10/11 or Server 2016+)

Requirements:

• Go 1.19 or newer (for building from source)
• Cloud CLI tools (AWS CLI, Azure CLI, or gcloud CLI)
• Read-only cloud credentials
• Internet connection (for downloading and scanning)

Disk Space:

• Binary: ~15 MB
• Source code: ~50 MB
• Scan results: ~1-10 MB per scan

Installation Methods

Option 1: Download Pre-Built Binary (Recommended)

Fastest and easiest method

# Download latest release
wget https://github.com/guardian-nexus/auditkit/releases/download/v0.7.0/auditkit-linux-amd64

# Make executable
chmod +x auditkit-linux-amd64

# Move to PATH
sudo mv auditkit-linux-amd64 /usr/local/bin/auditkit

# Verify installation
auditkit version

# Download latest release
curl -L https://github.com/guardian-nexus/auditkit/releases/download/v0.7.0/auditkit-darwin-amd64 -o auditkit

# Make executable
chmod +x auditkit

# Move to PATH
sudo mv auditkit /usr/local/bin/

# If you get security warning on first run:
# System Preferences > Security & Privacy > Allow

# Verify installation
auditkit version

# Download from GitHub Releases page
# https://github.com/guardian-nexus/auditkit/releases/download/v0.7.0/auditkit-windows-amd64.exe

# Rename to auditkit.exe
Rename-Item auditkit-windows-amd64.exe auditkit.exe

# Add to PATH or run from current directory
.\auditkit.exe version

Option 2: Build from Source

For developers or custom builds

Prerequisites

# Install Go 1.19 or newer
# Download from: https://go.dev/dl/

# Verify Go installation
go version  # Should show 1.19 or higher

Clone and Build

# Clone repository
git clone https://github.com/guardian-nexus/auditkit
cd auditkit/scanner

# Build binary
go build ./cmd/auditkit

# Binary is now at: ./auditkit

# Optional: Move to PATH
sudo mv auditkit /usr/local/bin/

# Verify installation
auditkit version

Build for Different Platforms

# Linux (amd64)
GOOS=linux GOARCH=amd64 go build -o auditkit-linux ./cmd/auditkit

# macOS (amd64)
GOOS=darwin GOARCH=amd64 go build -o auditkit-macos ./cmd/auditkit

# macOS (arm64 - M1/M2)
GOOS=darwin GOARCH=arm64 go build -o auditkit-macos-arm64 ./cmd/auditkit

# Windows (amd64)
GOOS=windows GOARCH=amd64 go build -o auditkit.exe ./cmd/auditkit

Option 3: Go Install

For Go users

# Install directly from GitHub
go install github.com/guardian-nexus/auditkit/scanner/cmd/auditkit@latest

# Binary installed to: $GOPATH/bin/auditkit

# Add GOPATH/bin to PATH if needed
export PATH=$PATH:$(go env GOPATH)/bin

# Verify installation
auditkit version

Installing Cloud CLI Tools

AuditKit requires cloud CLI tools for authentication.

# macOS
brew install awscli

# Ubuntu/Debian
sudo apt-get install awscli

# Or using pip
pip3 install awscli

# Verify installation
aws --version

# Download installer from:
# https://aws.amazon.com/cli/

# Or using Chocolatey
choco install awscli

# Verify installation
aws --version

# macOS
brew install azure-cli

# Ubuntu/Debian
curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash

# Verify installation
az --version

# Download installer from:
# https://docs.microsoft.com/cli/azure/install-azure-cli-windows

# Or using Chocolatey
choco install azure-cli

# Verify installation
az --version

# macOS
brew install google-cloud-sdk

# Linux - using snap
sudo snap install google-cloud-cli --classic

# Verify installation
gcloud --version

# Download installer from:
# https://cloud.google.com/sdk/docs/install

# Or using Chocolatey
choco install gcloudsdk

# Verify installation
gcloud --version

Verifying Installation

Check AuditKit Version

auditkit version

Expected output:

AuditKit v0.7.0
Built: 2025-10-19

Check Cloud CLI Tools

# AWS
aws --version

# Azure
az --version

# GCP
gcloud --version

Run Test Scan

# Test AWS (requires configured credentials)
auditkit scan -provider aws -framework soc2

# Test Azure (requires login)
auditkit scan -provider azure -framework soc2

# Test GCP (requires auth)
auditkit scan -provider gcp -framework soc2

Configuration

Setting Up Cloud Credentials

AWS:

aws configure
# Enter: Access Key ID, Secret Access Key, Region

Azure:

az login
export AZURE_SUBSCRIPTION_ID="your-subscription-id"

GCP:

gcloud auth application-default login
export GOOGLE_CLOUD_PROJECT=your-project-id

Detailed setup guides →

Troubleshooting Installation

"Command not found: auditkit"

Cause: Binary not in PATH

# Find where binary is located
which auditkit

# If not found, add to PATH
export PATH=$PATH:/path/to/auditkit/directory

# Or move to standard location
sudo mv auditkit /usr/local/bin/

"Permission denied" when running auditkit

Cause: Binary not executable

chmod +x auditkit

macOS "cannot be opened because the developer cannot be verified"

Cause: macOS Gatekeeper security

# Remove quarantine attribute
xattr -d com.apple.quarantine auditkit

# Or: System Preferences > Security & Privacy > Allow

Build errors with Go

Cause: Go version too old or dependencies missing

# Update Go to 1.19 or newer
go version

# Clean build cache
go clean -cache -modcache

# Rebuild
go build ./cmd/auditkit

Pro Version Installation

For AuditKit Pro customers:

1. Sign up for trial →
2. Receive license key via email
3. Download Pro binary from customer portal
4. Activate with license key

# Install Pro binary
chmod +x auditkit-pro
sudo mv auditkit-pro /usr/local/bin/auditkit-pro

# Activate license
auditkit-pro activate --license-key YOUR-LICENSE-KEY

# Verify Pro features enabled
auditkit-pro version  # Shows "Pro" edition

# Run Pro scans
auditkit-pro scan -provider aws -framework cmmc-l2

Pro feature details →

Next Steps