warning COPPA 2.0 enforcement begins April 22, 2026

Getting Started with Halo

Scan your codebase for compliance violations across 13 jurisdictions. 180 rules. AI-verified. Results in under two minutes.

1

Install the CLI

Get the Halo engine running locally on your development machine or CI environment.

npm install -g @runhalo/cli
npx runhalo scan . alternative
2

Activate Your License

Standard scans are free for open source. Commercial projects require a Pro license key.

halo activate --key YOUR_LICENSE_KEY
Free users can skip this step — 5 scans per month included. Get a Pro license arrow_forward
3

Run Your First Scan

Initialize a deep audit of your current directory and subdirectories.

halo scan .
halo scan . --review Pro

What's Next?

integration_instructions

Add to CI/CD

Automate compliance checks in GitHub Actions with the official Halo Action.

 extension

VS Code Extension

Real-time compliance linting while you write code.

 menu_book

View Documentation

Explore full rule set, flag definitions, and API specs.

 upgrade

Upgrade Your Plan

Unlimited scans, AI Review Board, and PDF compliance reports.

terminal Quick Reference

Common Flags
  • --review AI remediation
  • --format json Export result
  • --strict Fail on warning
  • --ignore [file] Exclude files
.halorc.json
{
  "jurisdictions": ["GDPR", "COPPA"],
  "threshold": "high",
  "reporting": {
    "output": "stdout",
    "format": "detailed"
  }
}

Need help?

Our compliance engineers are available for architecture reviews and custom rule generation.

mail support@runhalo.dev bug_report GitHub Issues

Built by Mindful Media