Documentation

Get started with acc in minutes

Quick Start

1. Install acc

# Download latest release
curl -LO https://github.com/cloudcwfranck/acc/releases/latest/download/acc_linux_amd64.tar.gz

# Extract and install
tar -xzf acc_*.tar.gz
sudo mv acc /usr/local/bin/

2. Initialize a project

acc init my-project

# This creates:
# .acc/           - Configuration directory
# .acc/profiles/  - Policy profiles
# acc.yaml        - Project config

3. Verify an artifact

# Verify with JSON output
acc verify --json myimage:latest

# Check exit code:
# 0 = pass, 1 = fail, 2 = cannot complete
echo $?

4. Use in CI/CD

# GitHub Actions example
- name: Verify image
  run: |
    acc verify --json myapp:latest
  # Fails the job if verification fails

Core Concepts

Policies

Write policies in Rego (OPA) stored in .acc/policy/. Policies define what's allowed and what's not.

Verification

Run acc verify to check artifacts against policies. Results are deterministic and machine-readable.

Exit Codes

0: Pass (compliant)
1: Fail (violations found)
2: Cannot complete (missing prerequisites)

Further Reading

Full READMEComplete guide including all commands, examples, and workflowsTesting ContractExit codes, JSON schemas, and behavioral guaranteesContributing GuideHow to run tests locally, development workflow, and contribution guidelinesAll DocumentationBrowse all docs including architecture, threat model, and more

Ready to get started?

Download Latest Release