Skip to main content

opencomplai-cli

License: AGPL-3.0 PyPI Python

The opencomplai command-line tool for AI compliance assessment. It scans your repository, classifies your AI system against the EU AI Act, reports gaps for every framework your manifest targets (NIST AI RMF 1.0 is derived from the EU AI Act evidence), and produces an auditable, CI-gateable compliance artifact.

Built on opencomplai-core — the same deterministic, rule-based risk engine, with a rich terminal UX.

Install

pip install opencomplai-cli

This pulls in opencomplai-core[reports] automatically. To install the full suite (engine + CLI) in one step, use the opencomplai meta-package instead.

Core commands

Command What it does
opencomplai init Scaffold a system-manifest.json for your project
opencomplai scan Corroborate the manifest against your code and report discrepancies
opencomplai check Run the compliance gate and write compliance-artifact.json
opencomplai push Publish a signed artifact (scan status or Annex IV dossier) to the Premium Dashboard
opencomplai checker Run the interactive EU AI Act applicability checker
opencomplai gaps Print a gap report for every target framework, the EU AI Act by default (informational — never gates CI)
opencomplai recommend Write copy-paste remediation templates for Missing/Partial gap-report rows
opencomplai report Render a single shareable HTML/PDF compliance report
opencomplai eval Run safety, bias, and data-leakage pipeline evaluators
opencomplai validate-manifest Validate a system-manifest.json against the required schema
opencomplai serve Start a localhost-only scan dashboard (not Pro/SaaS)
opencomplai approve Mint a signed HITL approval token for a HALTED_PENDING_REVIEW system
opencomplai resume Resume a HALTED_PENDING_REVIEW system with a signed approval token
opencomplai verify-output Verify an AI output claim against ground-truth sources
opencomplai version Show the installed Opencomplai version
opencomplai info Show full package metadata (pip show-style, across the whole suite)

Also available as command groups (opencomplai <group> --help for their own subcommands): docs (Annex IV dossier generation), risk (risk classification), sync (metadata sync), keys (signing-key rotation), ai (optional AI-intent plugin configuration), controls (control-register status).

Run opencomplai --help for the full command list, or opencomplai <command> --help for options.

Quick start

The self-serve path: mint a key on the dashboard, export two env vars, sign a scan, push it.

# 1. Scaffold a manifest for your project
opencomplai init

# 2. Cross-check the manifest against your source tree
opencomplai scan --manifest system-manifest.json --repo-root .

# 3. Get an API key from the dashboard's /connect page (Projects -> your
#    project -> Connect), then export it alongside the dashboard's ingest URL
export OPENCOMPLAI_API_KEY=ock_...
export OPENCOMPLAI_DASHBOARD_URL=https://your-dashboard-host/api/ingest

# 4. Run the compliance gate and sign the artifact (writes compliance-artifact.json)
opencomplai check --sign

# 5. Push the signed artifact to the dashboard
opencomplai push

Following this start-to-finish lands the scan on the dashboard's /systems page for that project. /connect also generates ready-to-paste GitHub Actions / GitLab CI snippets that wire the same two env vars into a pipeline — see CI integration.

opencomplai check is the canonical CI gate. Its exit code is contractual:

Exit code Meaning
0 PASS
1 CONTROL_FAIL
2 VALIDATION_FAIL
3 POLICY_BLOCK
4 TRAP_DETECTED

So you can wire it straight into CI:

opencomplai check || exit $?

To publish an Annex IV dossier instead of (or in addition to) a scan-status artifact, run opencomplai docs generate --system-id ... --push — same OPENCOMPLAI_API_KEY / OPENCOMPLAI_DASHBOARD_URL as opencomplai push above.

Optional: AI intent analysis

Install the opencomplai-ai plugin to unlock the --ai-intent flag, which classifies how each AI callsite is actually used:

pip install opencomplai-ai
opencomplai scan --ai-intent

Documentation

Full CLI reference and guides at docs.opencomplai.com.

License

AGPL-3.0-only. See LICENSE.

Metadata

Release files for opencomplai-cli 0.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for opencomplai-cli 0.8.0
File Size Uploaded
opencomplai_cli-0.8.0.tar.gz 245.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for opencomplai-cli 0.8.0
File Interpreter ABI Platform
opencomplai_cli-0.8.0-py3-none-any.whl Python 3 none any Details

Total release size: 424.5 kB

Release files / opencomplai_cli-0.8.0.tar.gz

Download URL opencomplai_cli-0.8.0.tar.gz
Size 245.8 kB
Tags Source
SHA-256 checksum
How to use checksums
ad90b920dc5a8c9d6215072236832661a6116113514501ec754e3650900745fb
BLAKE2b-256 checksum
How to use checksums
d067444e141be1371b10cffd6c96cf17fec10e236a2f43930718629e515598ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.

Transparency log

Release files / opencomplai_cli-0.8.0-py3-none-any.whl

Download URL opencomplai_cli-0.8.0-py3-none-any.whl
Size 178.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
76e55beda02d94ddcfa409c843fe453fa4ba28cc08b8609af44f46b67b1a0232
BLAKE2b-256 checksum
How to use checksums
ba3cb28ac3b25af2971c8a6b4bb2e8401befbef68726bc7abe76c0f8f5ff1870
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 24, 2026.

Transparency log

Release history Release notifications | RSS feed

0.9.1

2 release files

0.9.0

2 release files

This release

0.8.0 This release

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.1.2

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page