Skip to content

Show scan-summary

Home › Reference › Commands › Show › Scan Summary

show scan-summary - Generate pretty scan summary for a module

The show scan-summary command generates a formatted security scan summary with status per scan. This command is designed to be used in GitHub Actions workflows to create consistent, attractive scan summaries. The output is formatted as Markdown and can be redirected to $GITHUB_STEP_SUMMARY.

The command reads from the scan manifest at out/scan//scan.manifest.json. Status is derived from the manifest - success if all scans passed, failure otherwise.

Flags

Flag Description
--scans Comma-separated list of scans that were run (e.g., sbom,vuln,secrets)
--failed-scans Space-separated list of scans that failed
--artifact-name Name of the artifact containing scan results
--status Overall status (success or failure)

Notes

Expected Output:

  • Markdown-formatted scan summary with emojis and styling
  • Table showing each scan type with its pass/fail status
  • Artifact name for results download

See Also

Tutorials | How-to Guides | Explanation | Reference

You are here: Reference — information-oriented technical descriptions of the system.