Documentation
Everything you need to get started with AuditClaw, from installation to advanced configuration.
Quick Start
Install AuditClaw
Install from ClawHub (recommended) or download the ZIP manually.
Option A: Install from ClawHub
Option B: Manual download
SHA-256: 177abf39a5c6482cbfb4edcaa5d61220f5ed564b87aea9e10767abd8cdad6733
Initialize the database
Set up the compliance database. This creates all required tables automatically.
Activate your first framework
Tell the bot which compliance framework you need. Just chat naturally.
Bot: SOC 2 Type II activated. 43 controls loaded.
Start managing compliance
Ask anything. The AI understands natural language.
Core Concepts
Frameworks
Compliance standards like SOC 2, ISO 27001, HIPAA. Each framework has pre-built controls and cross-mappings to other frameworks. Activate/deactivate at any time.
Controls
Individual compliance requirements within a framework. Track status (not_started, in_progress, complete), assign owners, set due dates, measure effectiveness.
Evidence
Proof that a control is implemented. Can be manual uploads or auto-collected from AWS/GitHub. Has validity periods and cross-framework mappings.
Integrations
Connections to cloud providers (AWS, GitHub) for automated evidence collection. Register once, collect continuously via cron schedules.
Drift Detection
Monitors your compliance over time. If something that was passing starts failing, you get an alert immediately.
Alerts
Proactive notifications for expiring evidence, declining scores, connection errors, and compliance changes. Acknowledge and resolve through chat.
Action Reference
AuditClaw has 97 built-in commands organized by category. Here are the most commonly used ones.
Status & Scoring
| Command | What it does |
|---|---|
| status | Database overview: frameworks, controls, evidence counts |
| activate-framework | Load a framework and its controls |
| deactivate-framework | Soft-delete a framework (preserves data) |
| score-history | Compliance score trends over time |
Evidence Management
| Command | What it does |
|---|---|
| add-evidence | Create evidence record linked to controls |
| list-evidence | List evidence with filters |
| auto-map-evidence | Suggest cross-framework control links |
| list-evidence-gaps | Find controls without evidence |
Integrations & Monitoring
| Command | What it does |
|---|---|
| add-integration | Register a cloud provider (AWS, GitHub, Google, Okta) |
| integration-health | Health dashboard for all integrations |
| check-drift | Detect configuration regressions |
| compliance-calendar | Upcoming deadlines from all sources |
| compliance-digest | Activity summary (daily/weekly/monthly) |
Full reference for all 97 commands available on ClawHub and GitHub.
Slash Commands
Quick-access commands for common tasks. Type these directly in your chat.
/grc-scoreQuick compliance score with trend/grc-gapsTop priority gaps across frameworks/grc-scanSecurity scan menu (headers/SSL/GDPR)/grc-reportGenerate compliance report/grc-risksRisk register summary/grc-incidentsActive incidents overview/grc-trustGenerate trust center pageArchitecture
Skills
auditclaw-grc: Core GRC skillauditclaw-aws: AWS evidenceauditclaw-github: GitHub evidenceauditclaw-azure: Azure evidenceauditclaw-gcp: GCP evidenceauditclaw-idp: Google/Okta
Database
- SQLite (self-contained)
- 97 built-in commands
- JSON output format
- Auto-migrations included
Testing
- 431 automated tests
- Edge cases and error handling
- Python 3.10+
- 100% command coverage
AWS Integration Setup
1. Create an IAM user
Create a read-only IAM user with the included policy file.
aws iam put-user-policy --user-name auditclaw-readonly \
--policy-name AuditClawReadOnly \
--policy-document file://iam-policy.json
2. Configure credentials
Set your AWS credentials on the server.
3. Register the integration
Tell AuditClaw about your AWS account.
4. Run your first sweep
Collect evidence from all 15 AWS checks.
GitHub Integration Setup
1. Create a personal access token
Go to GitHub Settings > Developer settings > Fine-grained tokens. Grant read-only access to your organization's repos.
2. Set the token
3. Register and sweep
Ready to get started?
AuditClaw is free, open source, and ready for production.