AttackForge ReportGen CLI

AttackForge ReportGen is a free tool to help penetration testers create powerful and robust automated pentest reports.

It works by combining a DOCX template with an AttackForge project JSON file, and outputs a DOCX report.

The AttackForge ReportGen CLI provides users with a command-line tool suitable for creating reports in an automated way.

Example project data and DOCX templates, as well as additional tutorial material, are available on the AttackForge ReportGen page. A video presentation on the ReportGen product can be viewed here.

Additional support material is available on our Github Support Community.

Installation

It is recommended to install ReportGen CLI globally so that the reportgen command will be available in your path.

$ npm -g install @attackforge/reportgen-cli

Alternatively the ReportGen CLI can be executed directly without explicit installation.

$ npx @attackforge/reportgen-cli

Usage

$ reportgen [--output=output_file.docx] [--product=product] [--template=template_file.docx] [input_file.json]

Options

The AttackForge ReportGen CLI supports the following options:

| Option | Description | Required | |--|--|--| |--output|Specifies the output file path for the generated DOCX report.|Yes| |--template|Specifies the input file path for the DOCX report template.|Yes| |--product|Specifies the AttackForge product type. Either community, core, or enterprise. Defaults to core.|No|

Example Usage

$ reportgen --output=./report.docx --product=core --template=./templates/report_template.docx project1234.json

Creating Programmatic Reports

To programmatically create reports, it is recommended to use the AttackForge Self-Service API to retrieve the JSON report data for a given project.