The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Regula listing page.
Offline-capable, code-native AI governance scanning. The core scan runs locally, does not upload scanned file contents, and needs no account; telemetry is sent only with explicit opt-in consent. Regula flags patterns that may need review under the EU AI Act, South Korea's AI Basic Act, and Colorado SB 26-189, records the deployment facts code cannot show, and reports insufficient information rather than inventing a score.
Excerpt from the real output of the command shown, against the tracked fixture
examples/cv-screening-app. The per-category
counts that read zero and the next-steps footer are omitted for length; nothing
else is edited. scripts/verify_transcripts.py re-runs this command on every
check and fails if any line above stops appearing in its output.
Regula scans a local source-code folder for patterns that may need AI governance review. A questionnaire records facts that code cannot show, such as where and how a system will be used. Results identify candidate risk categories and link to provisions that may be relevant. Regula does not determine legal classification, compliance, or the obligations that apply to a real deployment.
Reference material covers the EU AI Act, South Korea's AI Basic Act (Act No. 20676), and Colorado SB 26-189. The core install has no required third-party runtime dependencies. Optional extras add dependencies, and some optional commands or configured features can contact external services. Assess territorial scope and data-processing duties independently.
In plain English: give Regula a source-code folder and answer questions about how the system will be used. It returns possible issues and a review trail so a developer, governance lead, or adviser can decide what to investigate next. A scan with no findings does not prove that a system is compliant or low risk.
| If you want to… | Start here |
|---|---|
| Explore the questions without installing anything | The browser assessment source is in site/assess/. The public Pages deployment is currently unavailable; when restored, it records declared context for review but does not inspect your repository or make a legal determination. |
| Check a local codebase | Follow the Quick start, then run regula check .. |
| Evaluate Regula before adopting it | Follow the 10-minute example journey and read the documented limitations and verification evidence. |
| Add a repeatable team check | Use the CI/CD example and review the exit-code policy before making it blocking. |
| Prepare material for a human reviewer | Generate a reviewer-completable evidence scaffold, then complete and validate its contextual fields. |
PyPI distribution is currently unavailable. The command above installs a moving public source reference; pin a reviewed commit hash for reproducible use. See docs/installation.md for the verified status and alternatives.
Not sure if the AI Act applies? No code needed:
The scan tells you which facts it needs and cannot get from code. You supply them, and the decision moves:
Declared facts are yours, not Regula's. Each is stored with who declared it,
through which command, in answer to which question, and when, in
.regula/facts.json, and the scan prints that provenance beside the decision.
unknown is an answer and is never read as no. A declared fact can move a
decision from insufficient_information to an indication; it does not produce a
risk tier, a compliance score, a readiness percentage or an effort estimate.
Want to scan your code?
Need a review pack?
Generated files are inputs to human review, not an audit opinion, certification, or proof of compliance.
Just want to see it work? (requires the cloned repo : examples/ is not bundled in the pip package)
The recommended install is pipx : it isolates Regula from your system Python and avoids the externally-managed-environment error on Ubuntu 22.04+, Debian 12+, Fedora, Arch, and Homebrew Python.
If you don't have pipx yet, install it first (one-time):
| Platform | Install pipx |
|---|---|
| macOS | brew install pipx && pipx ensurepath |
| Debian / Ubuntu | sudo apt install pipx && pipx ensurepath |
| Fedora | sudo dnf install pipx && pipx ensurepath |
| Arch | sudo pacman -S python-pipx && pipx ensurepath |
| Windows | python -m pip install --user pipx && python -m pipx ensurepath |
Already using uv? uvx --from git+https://github.com/kuzivaai/getregula.git@main regula runs the public source without a persistent install. Or install it with uv tool install git+https://github.com/kuzivaai/getregula.git@main.
Running inside a venv or conda env? Use pip install git+https://github.com/kuzivaai/getregula.git@main. The PEP 668 restriction applies to managed system Python, not an activated virtual environment.
See docs/installation.md for troubleshooting (externally-managed-environment, command not found: regula after install, PATH setup per shell).
The --scope all flag is needed because Regula's default scope (production) skips example directories. This fixture intentionally contains employment-related code indicators that exercise the Annex III Category 4 detector; the resulting label is a detector observation, not a legal determination.
See examples/ for runnable reference projects covering prohibited-practice, high-risk, transparency, and no-elevated-indicator scenarios, or walk through the full 10-minute evaluation journey in examples/cv-screening-app/ : install, scan, plan, gap, conform, verify, handoff to red-team tooling.
For a deeper first-time-user walk-through (policy tuning, CI integration, baselining) see docs/QUICKSTART.md. The full documentation is indexed by type (tutorials / how-to / reference / explanation) in docs/README.md.
The EU AI Act defines four risk tiers. Regula maps code patterns to each:
| Tier | Action | What it means |
|---|---|---|
| Potentially prohibited (Article 5) | Block indicator | Reports code patterns associated with listed practices for urgent contextual review. |
| Potentially high-risk (Article 6 and Annex III) | Warn + review map | Reports candidate use categories and maps provisions that may be relevant if a reviewer confirms the legal classification. |
| Potential transparency duty (Article 50) | Transparency indicator | Reports chatbot, synthetic-content and related implementation signals; the applicable paragraph and exceptions require review. |
| No elevated code indicator | Log only | Means the scanner did not observe a configured elevated indicator. It does not establish minimal-risk status or absence of legal duties. |
Every finding includes the relevant Article reference and explains when exceptions may apply. Regula flags patterns -- it does not make legal determinations.
Coverage has explicit levels. Regula has an evidence-gated questionnaire
and decision model for the EU AI Act, South Korea's AI Basic Act (Act No.
20676), and Colorado SB 26-189. It separately maps findings to selected control
or provision references in 13 frameworks, and publishes dated regional
trackers. A crosswalk or tracker is not an executable applicability decision or
a compliance assessment. See product coverage and user
journeys for the current capability
matrix and claim boundary. Use --jurisdictions on regula check to filter
selected reference mappings; that option also accepts uk, brazil, nist,
and iso, but it does not run an applicability decision. Use --jurisdiction eu, korea, or colorado on regula assess for the three implemented
decision-support configurations.
Developer guide sources: Python | JavaScript | Healthcare | Recruitment | Article 5 | Article 9 | Article 14 | Article 50
| Command | What it does |
|---|---|
regula | Scan the current directory, show an indicator summary and next steps |
regula check . | Detailed risk scan with per-file findings |
regula comply | EU AI Act obligation evidence and unresolved facts; --article 50 separates declared applicability facts from static implementation signals |
regula gap --project . | Compliance gap assessment against Articles 9-15 |
regula plan --project . | Prioritised remediation plan based on gap results |
regula fix --project . | Generate compliance fix scaffolds for findings |
regula evidence-pack --project . | Reviewer-completable evidence scaffold with integrity metadata |
regula conform --project . | Article 43 conformity assessment evidence pack |
regula dpv --project . | Export the risk indication as DPV-AIAct JSON-LD (aligned to the DPVCG EU-AIAct vocabulary) for RDF/GRC tooling |
regula check --ci . | CI mode -- exit code 1 on any WARN or BLOCK finding, SARIF output |
regula assess | Structured declared-context questionnaire for applicability and risk review |
regula demo | Scan a bundled example project -- zero-commitment trial |
regula api-server | Start the REST API (localhost:8487) with web dashboard |
regula conform --organisational | Governance self-assessment for Articles 9/17/27/72 |
regula questionnaire | Context-driven risk assessment questionnaire (also via REST API) |
regula exempt | Article 6(3) high-risk exemption decision tree |
regula oversight . | Article 14 human oversight analysis (cross-file flow tracing) |
regula guardrails . | Article 15 guardrail implementation coverage detection |
regula owasp-agentic | OWASP Top 10 for Agentic Applications assessment |
regula monitor | Analyse locally recorded agent/tool events for selected Article 12 record-keeping signals; it does not observe a running system by itself |
regula gdpr | GDPR cross-reference scan (14 focused checks, 4 AI Act/GDPR hotspots) |
regula bias | CrowS-Pairs bias evaluation (1,508 sentence pairs) with optional BBQ benchmark. Aligned with Digital Omnibus bias-testing safeguards (Article 4a, COM(2025)836). |
regula mcp-server | MCP server (JSON-RPC stdio) exposing three tools : regula_check, regula_classify, regula_gap : for Claude Code, Cursor, and other MCP clients |
regula install <integration> | Set up the pre-commit framework or direct Git hook integration |
Regula has 62 commands in total. Run regula --help-all for the full list, or see docs/cli-reference.md.
For GRC integration or non-terminal users:
Seven endpoints: /health, /v1/check, /v1/classify, /v1/gap, /v1/questionnaire, /v1/questionnaire/evaluate, /v1/dashboard. All return the same JSON envelope as the CLI. No auth -- run behind a reverse proxy for remote access.
The detailed tasks, failure paths, and required interface states are defined in product coverage and user journeys.
Regula is:
Regula is not:
regula bias runs benchmark probes against a local model as a starting point, but does not replace runtime fairness monitoring)Regula helps development teams find AI-governance questions earlier across its
implemented jurisdictions and reference frameworks. It does not replace the
organisational, procedural, domain, and legal work required for compliance. For
a detailed account of what falls outside Regula's scope, see
docs/what-regula-does-not-do.md, and for
Regula's own model card (intended use, training data, evaluation, known failure
modes) see docs/MODEL_CARD.md.
regula bias runs two social-bias benchmarks against a locally-hosted
language model (Ollama, llama3.2/mistral/qwen variants supported)
as evidence for EU AI Act Article 10 data-governance documentation.
| Benchmark | Paper | Method | What it measures |
|---|---|---|---|
| CrowS-Pairs | Nangia et al., 2020 | Log-probability difference between stereotypical and anti-stereotypical sentence pairs | Intrinsic bias in masked/causal LM output |
| BBQ | Parrish et al., 2022 | Question-answering on ambiguous-context prompts | Bias surfacing in downstream QA behaviour |
Both include Wilson confidence intervals for small-sample reliability and
bootstrap CIs for distribution estimates. Full methodology lives in
scripts/bias_eval.py and
docs/benchmarks/PRECISION_RECALL_2026_04.md.
Ethics statement. CrowS-Pairs and BBQ stereotype pairs are used
solely for scientific evaluation of model behaviour under controlled
conditions. Regula does not display individual stereotype pairs in
terminal output or reports : only aggregated scores, confidence
intervals, and benchmark-level verdicts. The pairs are distributed under
the dataset's own licence (CC BY-SA 4.0 for CrowS-Pairs) and are not
redistributed or modified by Regula. Opinions encoded in the stereotype
pairs do not reflect the views of the maintainer, Regula contributors,
or any user running the tool; their presence is instrumental, not
endorsing. regula bias is a development-time starting point for bias
documentation, not a production fairness monitor : see "What Regula is
(and isn't)" above.
Regula performs pattern-based risk indication, not legal risk classification.
benchmarks/README.md; they are not evidence of the
current detector's accuracy.| What | Count |
|---|---|
| CLI commands | 62 |
| Risk detection patterns (regexes) | 423 |
| Language families scanned | 8 (Python, JS, TS, Java, Go, Rust, C/C++, Jupyter) |
| Framework identifiers with selected references | 13 |
| Tests (pytest --collect-only) | 2,936 |
| Required production dependencies | 0 |
For reproduction commands, version-bounded benchmarks, known exceptions, security posture, and audit-trail design, see docs/TRUST.md. What version numbers promise, the public API they cover, and the deprecation policy: docs/VERSIONING.md.
Regula's core scan runs on your machine. No code, findings, or metadata are transmitted during a default scan. There is no account system or API key, and no telemetry by default (crash reporting requires both regula telemetry enable and an endpoint you configure yourself via REGULA_SENTRY_DSN; published builds ship none, and DO_NOT_TRACK suppresses it regardless). The tool reads your source files, analyses them locally, and writes output to your local filesystem. Explicit network-enabled operations include RFC 3161 timestamping, feed or update checks, and integrations you configure. See SECURITY.md for the full security posture.
Bug reports and pull requests are welcome.
pytest tests/ -q before opening a PR.scripts/risk_patterns.py. Each pattern should have a corresponding test.CONTRIBUTING.md for the full contributor guide and CHANGELOG.md for version history.Regula currently has a single maintainer. Where commits identify a co-author, that attribution records the tools or collaborators involved. The maintainer remains accountable for reviewing and accepting every merged change. See GOVERNANCE.md for the bus-factor limitation.
Engine and CLI: Apache License 2.0 OR European Union Public Licence v. 1.2 : at your option. Pick the one that fits your context:
You may choose either licence for any use. You do not need to state which one you picked, but attribution (keep the copyright notice and NOTICE file) is required under both.
Risk patterns and regulatory data: Detection Rule License (DRL) 1.1. You may use, modify, and redistribute the patterns freely. Attribution is required if you redistribute the patterns or use them in a product. If your tool generates match output from these patterns, the output must credit the source.
The SPDX expression for the full package is (Apache-2.0 OR EUPL-1.2) AND LicenseRef-DRL-1.1.