Skip to content

Commit 9c01cf7

Browse files
authored
Update README.md
1 parent c9fc203 commit 9c01cf7

1 file changed

Lines changed: 67 additions & 12 deletions

File tree

README.md

Lines changed: 67 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -264,30 +264,85 @@ with DAG('secure_rag_ingestion', start_date=datetime(2026, 1, 1)) as dag:
264264
Veritensor supports industry-standard formats for integration with security dashboards and audit tools.
265265

266266
### 1. Interactive HTML Dashboard
267-
Generate a visually rich, standalone HTML report designed for CISOs and security audits. Includes severity breakdowns, charts, and easy copy-to-clipboard functionality for Jira tickets.
267+
Generate a visually rich, standalone HTML report designed for CISOsand security audits. Includes severity breakdowns, charts, and copy-to-clipboard functionality for Jira tickets.
268+
268269
```bash
269270
veritensor scan ./models --html
271+
veritensor scan ./models --html --output-file report.html
270272
```
273+
### 2. EU AI Act Compliance Report
274+
Generate a standalone compliance gap report that maps scan findings to EU AI Act obligations (Articles 9–15, 17, 26, 50, 53). Includes a Readiness Score and required actions for each gap.
271275

272-
### 2. GitHub Security (SARIF)
273-
Generate a report compatible with GitHub Code Scanning:
274276
```bash
275-
veritensor scan ./models --sarif > veritensor-report.sarif
277+
# Standalone compliance HTML report
278+
veritensor scan ./models --compliance eu-ai-act
279+
280+
# HTML report + EU AI Act section combined
281+
veritensor scan ./models --html --compliance eu-ai-act
282+
283+
# Save to specific path
284+
veritensor scan ./models --compliance eu-ai-act \
285+
--output-file compliance-report.html
276286
```
277-
### 3. Software Bill of Materials (SBOM)
278-
Generate a CycloneDX v1.5 SBOM to inventory your AI assets:
287+
288+
Output example:
289+
🇪🇺 EU AI Act Readiness Score: 57%
290+
Compliance gaps: 3 article(s) affected
291+
┌─ GAPS DETECTED ──────────────────────────────────────
292+
│ Article 9 — Risk Management System [High Risk]
293+
│ Action: Remediate CRITICAL findings before production...
294+
│ Article 10 — Data and Data Governance [High Risk]
295+
│ Action: Review flagged datasets for PII...
296+
│ Article 13 — Transparency [High Risk]
297+
│ Action: Verify model provenance against HuggingFace...
298+
└──────────────────────────────────────────────────────
299+
300+
### 3. GitHub Security (SARIF)
301+
Generate a report compatible with GitHub Code Scanning and GitHub Advanced Security.
302+
279303
```bash
280-
veritensor scan ./models --sbom > sbom.json
304+
veritensor scan ./models --sarif
305+
veritensor scan ./models --sarif --output-file report.sarif
281306
```
282-
### 4. Raw JSON
283-
For custom parsers and SOAR automation:
307+
308+
### 4. Software Bill of Materials (AI-BOM)
309+
Generate a CycloneDX 1.5 AI-BOM to inventory AI artifacts. Required for EU AI Act Article 11 technical documentation.
310+
284311
```bash
285-
veritensor scan ./models --json
312+
veritensor scan ./models --sbom
313+
veritensor scan ./models --sbom --output-file sbom.json
286314
```
287-
### 5. Excel report
288-
Create an Excel report with data about the problems:
315+
316+
### 5. Excel Report (Audit-Ready)
317+
Generate a multi-sheet Excel workbook for compliance auditors. Sheets: Summary, Incidents (one row per threat), All Files.
318+
289319
```bash
290320
veritensor scan ./models --excel
321+
veritensor scan ./models --excel --output-file audit-report.xlsx
322+
```
323+
324+
### 6. Raw JSON
325+
For custom parsers, SOAR automation, and pipeline integration.
326+
327+
```bash
328+
veritensor scan ./models --json
329+
veritensor scan ./models --json --output-file results.json
330+
```
331+
332+
### 7. Combining formats
333+
Multiple output flags can be combined in a single scan:
334+
335+
```bash
336+
# Full audit package: HTML + Excel + EU AI Act compliance
337+
veritensor scan ./models \
338+
--html \
339+
--excel \
340+
--compliance eu-ai-act
341+
342+
# CI/CD: SARIF for GitHub + JSON for SOAR
343+
veritensor scan ./models \
344+
--sarif --output-file report.sarif \
345+
--json --output-file results.json
291346
```
292347
---
293348

0 commit comments

Comments
 (0)