scan target/home/runner/work/oh-pen-testing/oh-pen-testing/packages/websetup in progress: scan target will lock in once you finish the wizard
La Guida · 05

Reports

Export findings in four formats, from a quick markdown summary to a consultancy-grade PDF.

Basic usage

Reports are generated from the issues and scan data already in .ohpentesting/. Run opt scan first, then generate a report in any format:

opt report --format markdown   # default
opt report --format json
opt report --format sarif
opt report --format pdf

# Combine formats in one pass
opt report --format markdown,json,sarif

Output files are written to .ohpentesting/reports/ with a timestamp in the filename.

Formats
.md
Markdownhuman-readable

A structured narrative report: executive summary, findings by severity, per-issue analysis, and remediation status. Drop it into Notion, Confluence, or a GitHub issue.

--format markdown
.json
JSONmachine-readable

Full structured output of every scan, issue, agent run, and verification result. Feed it into your own dashboards, compliance pipelines, or CI checks.

--format json
.sarif
SARIF 2.1.0CI integration

The Static Analysis Results Interchange Format. Upload to GitHub Code Scanning, Snyk, Sonatype, or any SARIF-compatible viewer to get inline annotations on your PRs.

--format sarif
.pdf
PDFconsultancy

A polished, print-ready penetration test deliverable. Suitable for handing to clients, legal, or compliance teams. Includes scope, methodology, findings table, and appendices.

--format pdf
GitHub Code Scanning (SARIF)

Upload the SARIF report to GitHub to get inline annotations on pull requests and a persistent security overview on your repo:

opt report --format sarif

# Upload via the GitHub CLI
gh api \
  --method POST \
  -H "Accept: application/vnd.github+json" \
  /repos/OWNER/REPO/code-scanning/sarifs \
  -f commit_sha=$(git rev-parse HEAD) \
  -f ref=$(git symbolic-ref HEAD) \
  -f sarif=$(cat .ohpentesting/reports/*.sarif | base64)

Or add an upload-sarif step to your GitHub Actions workflow using the github/codeql-action/upload-sarif action.