Summary: Manage reports, the central containers for all collected data like notes, loot, and parser findings.

Managing Reports

A report is the central container for all your analytical findings for an engagement. It is designed to store everything you discover, keeping your notes, credentials, and automated parser results organized in one place.

What a Report Stores

• Notes: Your timestamped, free-form observations.
• Loot: Structured findings like credentials, keys, and flags.
• Parser Findings: Structured data extracted from tool output by the parser command.

Core Commands

Creating and Loading

You start by creating a report for your project and then loading it into your session.

report add my-project-report
report load my-project-report
# The prompt will now show '[my-project-report]' to indicate it's loaded.

Viewing a Report

You can view the contents of any report, or the currently loaded one.

report show my-project-report
report show # Shows the currently loaded report

Listing and Unloading

report list # Shows all available reports
report unload # Unloads the report from the current session

Renaming and Deleting

report rename my-project-report new-name
report destroy new-name # This permanently deletes the report file

Exporting a Report

To back up, share, or version-control a report, use the export command. It generates a script of pwnity commands that can perfectly reconstruct the report, including all notes and loot.

report export my-project-report
# This will print the commands to the console. You can copy this output
# and save it to a file (e.g., 'my-backup.pwn') to be run with 'run_script'.

Rendering a Report to a File

To create a clean, human-readable summary of a report for documentation or sharing, use the render command. It saves the output as a Markdown file.

report render my-project-report
# Saves a summary to 'exports/reports/my-project-report.md'

report render my-project-report final_summary.md
# Saves the summary to 'exports/reports/final_summary.md'