Outputs overview
One scan can emit multiple formats. Use the format that matches the consumer.--format is repeatable when you need several artifacts from one run. See each format page for structure and caveats.Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Choose CBOM, SARIF, Markdown/HTML, or JSON for the same scan.
| Format | Flag | Best for |
|---|---|---|
| CycloneDX CBOM | --format cbom | Machine-readable inventory; CycloneDX-aware tools and GRC ingest |
| SARIF | --format sarif | GitHub Security tab, SARIF viewers, build gates |
| Markdown / HTML | --format markdown / html | Human deliverable for architects and migration owners |
| JSON | --format json | Custom tooling and internal pipelines |
cryptarium scan . --format cbom --output cbom.json
cryptarium scan . --format sarif --output results.sarif
cryptarium scan . --format markdown --output CRYPTO-REPORT.md
--format is repeatable when you need several artifacts from one run. See each format page for structure and caveats.