Skip to content

README.md

Latest commit

 

History

History
60 lines (46 loc) · 1.18 KB

README.md

File metadata and controls

60 lines (46 loc) · 1.18 KB

CARL Report Maker

This application generates reports (PDF or HTML) using the output generated by CARL CLI.

Installation

Run the following command line if you want to use node.js

npm install
node reportmaker.js --help

Instructions

Please follow the instructions and provide the right inputs to generate the expected report:

--input: path to the folder where to find the CARL output
--output: path where the report will be saved
--report: OWASP2021|OWASP2017|OWASP2013|CWETop252011|CWETop252019|OWASPMobile2016|PCI-DSS  (CAST Health Factors if empty)
--format: PDF|HTML (PDF by default)

Templates

List of (security) templates:

  • OWASP2021
  • OWASP2017
  • OWASP2013
  • CWETop252011
  • CWETop252019
  • OWASPMobile2016
  • PCI-DSS

Don't forget to provide paths according to your OS:

UNIX Path: /path/to/my/report
WINDOWS Path: D:\path\to\my\report

Tests

npm run test

How to generate executables from reportmaker.js

npm install -g pkg
pkg .

Use the executables when compiled

Run the following command lines with predefined executable

CARL-ReportMaker-linux --help
CARL-ReportMaker-macos --help
CARL-ReportMaker-win.exe --help