diff --git a/README.md b/README.md index b2260f2..c7f8c8b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,26 @@ # MITRE Caldera Plugin: Debrief -A Caldera plugin: https://github.com/mitre/caldera +## Overview: -Debrief is a plugin for gathering overall campaign information and analytics for a selected set of -operations. It provides a centralized view of operation metadata, graphical displays of the operations, -the techniques and tactics used, and the facts discovered by the operations. The plugin additionally -supports the export of campaign information and analytics in PDF format. +The Debrief plugin provides post-operation insights and reporting. This plugin does so by gathering overall campaign information and analytics for a selected set of operations. It then provides a centralized view of operation metadata, graphical displays of the operations, the techniques and tactics used, and the facts discovered by the operations. The plugin additionally supports the export of campaign information and analytics in PDF format. -Example generated PDF: [Caldera Debrief Report](docs/debrief_2023-02-24_17-08-14.pdf) +### Context: +Reporting / post-execution analysis + + + + +## Installation: + +This is a core CALDERA plugin and is loaded by default via the plugin loader. Ensure it is present in the `plugins/` directory and listed as enabled in your active configuration file (e.g., `conf/default.yml`). + +## Dependencies/Requirements: + +No additional dependencies are required beyond a standard CALDERA installation. + +## Getting Started: + +Here is an example of the generated PDF: [Caldera Debrief Report](docs/debrief_2023-02-24_17-08-14.pdf) ![plugin home](docs/debrief1.png) ![plugin home](docs/debrief2.png)