Skip to content

Commands

Interactively creates a .rulestatus.yaml configuration file.

Terminal window
rulestatus init
rulestatus init --actor provider --risk-level high-risk --frameworks eu-ai-act

The first prompt asks what’s driving the setup — enterprise security review, EU market deployment, internal audit, or exploring. The answer pre-selects the right defaults and produces a context-aware summary at the end.

For the enterprise security review path, the outro lists the four articles most commonly requested in EU AI vendor security reviews (Articles 9, 10, 11, 13) and the exact commands to fix each gap.

OptionDefaultDescription
--actorcontext-dependentActor type: provider, deployer, importer, distributor
--risk-levelcontext-dependentRisk level: prohibited, high-risk, limited-risk, minimal-risk
--frameworkscontext-dependentComma-separated frameworks to enable
--name(prompt)AI system name

Run compliance checks and print results to the console (and optionally write report files).

Terminal window
rulestatus run
rulestatus run --framework eu-ai-act --format console,json,sarif
rulestatus run --article 9 --severity critical
OptionDefaultDescription
--frameworkallLimit to one framework (e.g. eu-ai-act, iso-42001, nist-ai-rmf)
--articleallRun only rules for this article/clause number
--severityallRun only rules at this severity or higher
--formatconsoleOutput formats: console, json, sarif, pdf, badge, junit
--output./compliance-reportsOutput directory for report files

Exits non-zero when any result at or above severity_gate.fail_on fails.


Scaffold a compliance artifact template with inline field explanations.

Terminal window
rulestatus generate # interactive picker
rulestatus generate risk-register
rulestatus generate --all # scaffold everything at once
TemplateOutput pathCovers
risk-registerdocs/risk_register.yamlArt. 9.2
risk-managementdocs/risk-management/risk-management.yamlArt. 9.1–9.3
model-cardmodel/model_card.yamlArt. 10, 11
data-governancedocs/compliance/data-governance.yamlArt. 10
bias-assessmentdocs/bias_assessment.yamlArt. 10.2
technical-docdocs/compliance/technical-documentation.yamlArt. 11 (Annex IV)
transparency-configconfig/transparency.yamlArt. 13.1, 13.4
instructions-for-usedocs/compliance/instructions-for-use.yamlArt. 13.2–13.4

Show legal basis, last-run context, and remediation steps for a specific assertion.

Terminal window
rulestatus explain ASSERT-EU-AI-ACT-009-001-01

Prints the legal text, what the last run found (or didn’t find), and the exact fix to apply. For EU AI Act rules, also shows WHY THIS BLOCKS DEALS — a plain-English explanation of why that specific gap stalls enterprise procurement.


Re-render a saved JSON results file in another format without re-running checks.

Terminal window
rulestatus report compliance-reports/eu-ai-act-2025-01-01.json --format pdf
rulestatus report results.json --format sarif --output my-report.sarif
OptionDefaultDescription
--formatpdfOutput format: console, pdf, sarif, junit, badge
--outputcompliance-report.<ext>Output file path

Package all compliance artifacts into an audit-ready .tar.gz archive.

Terminal window
rulestatus bundle
rulestatus bundle --output artifacts/my-system-2025-01-01.tar.gz

The archive contains:

  • manifest.json — system metadata, framework list, last-run summary
  • evidence/ — all docs, config, model card, risk register files from your config paths
  • reports/last-run.json — last run results with evidence hashes
OptionDefaultDescription
--output.rulestatus/<name>-<timestamp>.tar.gzOutput path
--namesystem name from configBundle name prefix

Cryptographically sign a compliance artifact, or generate a manual sign-off template for a specific assertion.

Terminal window
# Cryptographic attestation of a bundle file
rulestatus attest .rulestatus/my-system-2025-01-01.tar.gz
rulestatus attest bundle.tar.gz --provider github # Sigstore via gh CLI (CI)
rulestatus attest bundle.tar.gz --provider cosign
# Manual sign-off template for a MANUAL-status assertion
rulestatus attest ASSERT-EU-AI-ACT-013-001-01

In file mode, writes <file>.sha256 and <file>.attestation.json. With --provider github or cosign, submits to Sigstore/Rekor for OIDC-backed proof.

In ASSERT-ID mode, writes .rulestatus/attestations/<ASSERT-ID>.yaml — a YAML template you fill in and commit. The git commit provides identity, timestamp, and immutability.

OptionDefaultDescription
--providergithub in CI, none otherwiseSigning provider: github, cosign, none
--output<file>.attestation.jsonOutput path for attestation JSON

Export all assertions and obligations as YAML files for legal review or integration.

Terminal window
rulestatus export-registry
rulestatus export-registry --framework eu-ai-act --output ./my-registry

Outputs per framework:

  • registry/<framework>/assertions.yaml — one entry per assertion with full metadata
  • registry/<framework>/obligations.yaml — deduplicated obligations listing their assertion IDs
OptionDefaultDescription
--outputregistry/Output directory
--frameworkallLimit to one framework

These files are generated — never edit them manually. Regenerate after any rule change.


OptionDescription
--config <path>Path to .rulestatus.yaml (default: auto-detected)
--versionPrint version
--helpShow help