Generate reports
Pro
You can export scan results in several formats from the “Export” tab of an aborted or completed revision scan.
CLI
There are 2 reference report format types that you may encounter when using Apex:
*.crf– Cuboid report file.*.aer– Apex report.
Both of these files can be handled by the CLI apex_reporter utility in order
to convert them to a multitude of formats or print the results to STDOUT.
For example, to generate an HTML report:
bin/apex_reporter --report=html:outfile=my_report.html.zip /home/user/.apex/reports/report.aer
Or, to just print the report to STDOUT:
bin/apex_reporter --report=stdout /home/user/.apex/reports/report.aer
At the time of writing, bin/apex_reporter --reporters-list yields:
[~] Available reports:
[*] ap:
--------------------
Name: AP
Description:
Awesome prints a scan report hash.
Author: Tasos "Zapotek" Laskos <[email protected]>
Version: 0.1.1
Path: /home/zapotek/workspace/rkn/application/components/reporters/ap.rb
[*] html:
--------------------
Name: HTML
Description:
Exports the sink-trace entries as a compressed HTML report.
Options:
[~] outfile - Where to save the report.
[~] Type: string
[~] Default: 2026-06-04_11_40_13_+0300.html.zip
[~] Required?: false
Author: Tasos "Zapotek" Laskos <[email protected]>
Version: 0.5.0
Path: /home/zapotek/workspace/rkn/application/components/reporters/html.rb
[*] json:
--------------------
Name: JSON
Description:
Exports the audit results as a JSON (.json) file.
Options:
[~] outfile - Where to save the report.
[~] Type: string
[~] Default: 2026-06-04_11_40_13_+0300.json
[~] Required?: false
Author: Tasos "Zapotek" Laskos <[email protected]>
Version: 0.1.3
Path: /home/zapotek/workspace/rkn/application/components/reporters/json.rb
[*] markdown:
--------------------
Name: Markdown
Description:
Exports the audit results as a Markdown (.md) file.
Options:
[~] outfile - Where to save the report.
[~] Type: string
[~] Default: 2026-06-04_11_40_13_+0300.md
[~] Required?: false
[~] ai_friendly - Emit a flatter, compacter Markdown variant tuned for LLM ingestion (no TOC, blobs truncated, explicit section markers).
[~] Type: bool
[~] Default: false
[~] Required?: false
Author: Tasos "Zapotek" Laskos <[email protected]>
Version: 0.1
Path: /home/zapotek/workspace/rkn/application/components/reporters/markdown.rb
[*] marshal:
--------------------
Name: Marshal
Description:
Exports the audit results as a Marshal (.marshal) file.
Options:
[~] outfile - Where to save the report.
[~] Type: string
[~] Default: 2026-06-04_11_40_13_+0300.marshal
[~] Required?: false
Author: Tasos "Zapotek" Laskos <[email protected]>
Version: 0.1.1
Path: /home/zapotek/workspace/rkn/application/components/reporters/marshal.rb
[*] pdf:
--------------------
Name: PDF
Description:
Exports the audit results as a PDF (.pdf) file.
Options:
[~] outfile - Where to save the report.
[~] Type: string
[~] Default: 2026-06-04_11_40_13_+0300.pdf
[~] Required?: false
Author: Tasos "Zapotek" Laskos <[email protected]>
Version: 0.5
Path: /home/zapotek/workspace/rkn/application/components/reporters/pdf.rb
[*] stdout:
--------------------
Name: Stdout
Description:
Prints the results to standard output.
Author: Tasos "Zapotek" Laskos <[email protected]>
Version: 0.3.3
Path: /home/zapotek/workspace/rkn/application/components/reporters/stdout.rb
[*] txt:
--------------------
Name: Text
Description:
Exports the audit results as a text (.txt) file.
Options:
[~] outfile - Where to save the report.
[~] Type: string
[~] Default: 2026-06-04_11_40_13_+0300.txt
[~] Required?: false
Author: Tasos "Zapotek" Laskos <[email protected]>
Version: 0.2.1
Path: /home/zapotek/workspace/rkn/application/components/reporters/txt.rb
[*] xml:
--------------------
Name: XML
Description:
Exports the sink-trace entries as an XML (.xml) file.
Options:
[~] outfile - Where to save the report.
[~] Type: string
[~] Default: 2026-06-04_11_40_13_+0300.xml
[~] Required?: false
Author: Tasos "Zapotek" Laskos <[email protected]>
Version: 0.5.0
Path: /home/zapotek/workspace/rkn/application/components/reporters/xml.rb
[*] yaml:
--------------------
Name: YAML
Description:
Exports the audit results as a YAML (.yaml) file.
Options:
[~] outfile - Where to save the report.
[~] Type: string
[~] Default: 2026-06-04_11_40_13_+0300.yaml
[~] Required?: false
Author: Tasos "Zapotek" Laskos <[email protected]>
Version: 0.2
Path: /home/zapotek/workspace/rkn/application/components/reporters/yaml.rb