Docs

Get up and running

Quick links

• Quickstart (5 min)
• REST API reference
• SDKs + CLI + Terraform
• Integration catalogue
• Framework mappings
• Self-host on Docker / k8s
• Audit-pack export

Quickstart

1. Sign up — /#signupForm (free, $10 wallet, 1 target).
2. Add your first asset (a URL, a code repo, a cloud account).
3. Run a Sentinel scan — first finding lands within ~30 seconds.
4. Adopt a policy template (e.g. isms-policy) → Compliancly fills your org tokens → publish.
5. Connect Slack/Teams or webhook to get alerts when high-severity findings land.

REST API

OpenAPI spec for tenant-facing endpoints: app.compliancly.ai/api/tenant/openapi.json · findings · asset · agent.

Common pattern:

curl -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     https://app.compliancly.ai/api/findings/v1/findings/stats/summary

Framework mappings

Full catalogue: /api/findings/v1/control/catalogue. Per-framework status: /api/findings/v1/frameworks/catalogue.

Self-host

Docker compose v2 + 4 vCPU + 8 GB RAM machine. Single-VM bootstrap script: scripts/deploy-single-vm.sh. Production multi-AZ: see terraform/aws/.

Audit-pack export

From any framework view, click Export audit pack → ZIP with policies (PDF + DOCX), control evidence, scan reports, training certificates, and an auditor cover letter. Available on Starter+ plans.

More guides being written. Specific question? Email support@compliancly.ai.