Skip to content

OUTPUTS.md

Latest commit

 

History

History
99 lines (66 loc) · 2.17 KB

OUTPUTS.md

File metadata and controls

99 lines (66 loc) · 2.17 KB

Output Formats

Frontguard supports multiple output styles.

If you are not sure which one to pick, run the guided wizard:

frontguard start

It explains each output option before running the scan.

Human Text

Default terminal output:

frontguard scan ./dist

This is compact and readable.

Copy-Friendly Markdown

frontguard scan ./dist --copy
frontguard deep-scan http://localhost:3000 --copy

Use this for:

  • GitHub issues
  • Pull requests
  • Slack
  • Docs
  • AI coding assistant prompts

The report includes:

  • Frontguard Score out of 100
  • Summary counts
  • Scan context
  • Findings
  • Evidence
  • Recommendations
  • Defensive verification guidance
  • Possible false-positive notes

JSON

frontguard scan ./dist --json --output report.json

Use JSON for automation or later conversion with:

frontguard report report.json --markdown

JSON reports are friendly by default: Frontguard keeps findings, metadata, headers, and summaries of captured assets/bodies, but it does not dump full HTML, JavaScript, request bodies, or response bodies into the terminal. Each captured body gets a length, SHA-256, and short preview instead.

If you need the complete captured evidence for local debugging, opt in explicitly:

frontguard scan ./dist --json --raw --output full-evidence.json

Only use --raw for trusted local handling because it can include full client assets and captured traffic bodies.

Third-Party Evidence

Frontguard focuses on first-party and same-site evidence by default. This keeps reports centered on the app you own and avoids noisy findings from analytics, CDNs, and external SDK hosts.

frontguard scan https://example.com --include-third-party

Use --include-third-party when you intentionally want to review external scripts, headers, and traffic too.

SARIF

frontguard scan ./dist --sarif --output report.sarif

SARIF is useful for code scanning integrations and security dashboards.

CI Exit Codes

frontguard scan ./dist --ci --fail-on high

Exit behavior:

  • 0: no findings at or above the threshold
  • 1: findings met the failure threshold
  • 2: scanner/runtime error