Quick start guide

Get Audrex up and running in under 5 minutes. Analyze your first document, run a breach simulation, and let AI agents fix compliance gaps automatically.

Prerequisites

Docker 20+ & Docker Compose v2

Node.js 18+ (for CLI tools)

A GitHub account with repo access

Slack workspace (optional, for alerts)

Installation steps

Clone & Configure

Clone the repo and copy the .env.example to .env. Set your API keys and database URL.

Start Services

Run docker compose up -d to start the backend, frontend, and PostgreSQL database.

Connect & Scan

Open the dashboard, connect your GitHub repo, select frameworks, and run your first scan.

bash

# Clone the repository
git clone https://github.com/your-org/audrex.git && cd audrex

# Copy environment config
cp .env.example .env

# Start all services
docker compose up -d

# Verify everything is running
curl http://localhost:8000/api/v1/health

Authentication

All API requests use Bearer token authentication.

bash

# Login and get your token
curl -X POST https://api.audrex.ai/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "you@company.com", "password": "your-password"}'

# Response
{
  "access_token": "eyJhbGciOiJIUzI1...",
  "token_type": "bearer",
  "user_id": "uuid",
  "tenant_id": "uuid"
}

First scan

Your first scan may take 30–60 seconds while AI models warm up. Subsequent scans are significantly faster.

bash

# Run a GDPR breach simulation
curl -X POST https://api.audrex.ai/api/v1/simulation \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "S3 Bucket Data Exposure",
    "description": "Public S3 bucket containing customer PII",
    "framework": "GDPR"
  }'

Expected output

json

{
  "id": "sim_abc123",
  "verdict": "breach_simulated",
  "confidence_score": 0.92,
  "framework": "GDPR",
  "gaps": [
    {
      "article": "Art. 32",
      "title": "Security of Processing",
      "severity": "CRITICAL",
      "remediation_status": "auto_fix_available"
    }
  ],
  "duration_seconds": 4.2,
  "evidence_summary": "Detected unencrypted PII in S3..."
}