Skip to content
ComplyForm Docs

Quickstart

1. Install

Section titled “1. Install”
Terminal window
uv tool install complyform

Verify the install:

Terminal window
complyform --version

2. Scan

Section titled “2. Scan”

Discover resources from your Terraform state file:

Terminal window
complyform scan --state=terraform.tfstate
Scanning terraform.tfstate...
Found 42 resources across 3 services (Cloud SQL, GCS, Cloud Run)
Scan complete — results cached.

3. Assess

Section titled “3. Assess”

Map discovered resources against a compliance framework:

Terminal window
complyform assess --frameworks=soc2
Assessing 42 resources against SOC 2 (149 controls)...


CC6.1  Logical Access Controls     FAIL  google_sql_database_instance.production
CC6.7  Data Encryption             PASS  google_storage_bucket.artifacts
CC7.2  System Monitoring           FAIL  google_cloud_run_service.api
...


Result: 38/149 controls passing — 26% compliant

4. Remediate

Section titled “4. Remediate”

Generate Terraform patches for failing controls:

Terminal window
complyform remediate --frameworks=soc2
Generating patches for 111 failing controls...


  patches/google_sql_database_instance_production.tf  (CC6.1, CC6.6)
  patches/google_cloud_run_service_api.tf             (CC7.2, CC7.5)
  patches/google_storage_bucket_artifacts.tf          (CC6.7)
...


Wrote 23 patch files to ./patches/

5. Validate

Section titled “5. Validate”

Apply the patches and confirm compliance:

Terminal window
complyform validate
Validating patched state against SOC 2...


Result: 149/149 controls passing — 100% compliant

Next steps

Section titled “Next steps”