Picket.Report API

Generated from XML documentation for Picket.Report.

Types

• GitleaksCsvReportWriter - Writes a Gitleaks-shaped CSV report with deterministic column ordering.
• GitleaksFindingRedactor - Applies Gitleaks-compatible finding redaction before reports are written.
• GitleaksJsonReportWriter - Writes a Gitleaks-shaped JSON report with deterministic field ordering.
• GitleaksJunitReportWriter - Writes a Gitleaks-shaped JUnit XML report.
• GitleaksSarifReportWriter - Writes a Gitleaks-shaped SARIF 2.1.0 report.
• GitleaksTemplateReportWriter - Writes Gitleaks template reports for common Go text/template report templates.
• PicketCsvReportWriter - Writes Picket-native CSV reports with stable finding metadata columns.
• PicketGitLabCodeQualityReportWriter - Writes Picket findings as a GitLab Code Quality report.
• PicketHtmlReportWriter - Writes self-contained Picket-native HTML reports.
• PicketJsonReportWriter - Writes Picket-native JSON reports with schema and rule metadata.
• PicketJsonlReportWriter - Writes Picket-native JSON Lines reports with one finding per line.
• PicketJunitReportWriter - Writes Picket-native JUnit XML reports.
• PicketSarifReportWriter - Writes Picket-native SARIF 2.1.0 reports for code-scanning systems.
• PicketToonReportWriter - Writes Picket-native TOON reports for compact LLM-oriented triage.
• ReportFindingReader - Reads finding records from reports that preserve raw secret material.
• ReportFindingSummary - Represents the non-secret fields needed to triage a report finding.
• ReportSummary - Represents a non-secret summary of a secrets report.
• ReportSummaryReader - Reads non-secret summaries from Picket, Gitleaks, and SARIF report files.

GitleaksCsvReportWriter

Picket.Report.GitleaksCsvReportWriter

Writes a Gitleaks-shaped CSV report with deterministic column ordering.

Methods

• Write(IReadOnlyList<Finding>) - Writes findings to a UTF-8 CSV string.

GitleaksFindingRedactor

Picket.Report.GitleaksFindingRedactor

Applies Gitleaks-compatible finding redaction before reports are written.

Methods

• Redact(Finding finding, int redactionPercent) - Redacts a finding secret using the supplied percentage.
• Redact(Finding finding, int redactionPercent, bool requirePartialMask) - Redacts a finding secret using the supplied percentage.
• Redact(IReadOnlyList<Finding> findings, int redactionPercent) - Redacts secrets in each finding using the supplied percentage.
• Redact(IReadOnlyList<Finding> findings, int redactionPercent, bool requirePartialMask) - Redacts secrets in each finding using the supplied percentage.

GitleaksJsonReportWriter

Picket.Report.GitleaksJsonReportWriter

Writes a Gitleaks-shaped JSON report with deterministic field ordering.

Methods

• Write(IReadOnlyList<Finding>) - Writes findings to a UTF-8 JSON string.

GitleaksJunitReportWriter

Picket.Report.GitleaksJunitReportWriter

Writes a Gitleaks-shaped JUnit XML report.

Methods

• Write(IReadOnlyList<Finding>) - Writes findings to a UTF-8 JUnit XML string.

GitleaksSarifReportWriter

Picket.Report.GitleaksSarifReportWriter

Writes a Gitleaks-shaped SARIF 2.1.0 report.

Methods

• Write(IReadOnlyList<Finding> findings, IReadOnlyList<SecretRule> rules) - Writes findings and ordered rules to a UTF-8 SARIF JSON string.

GitleaksTemplateReportWriter

Picket.Report.GitleaksTemplateReportWriter

Writes Gitleaks template reports for common Go text/template report templates.

Methods

• Write(IReadOnlyList<Finding> findings, string templateText) - Renders findings with a Gitleaks-compatible template.

PicketCsvReportWriter

Picket.Report.PicketCsvReportWriter

Writes Picket-native CSV reports with stable finding metadata columns.

Methods

• Write(IReadOnlyList<Finding> findings) - Writes findings to a deterministic UTF-8 CSV string.
• Write(IReadOnlyList<Finding> findings, IReadOnlyList<SecretRule> rules) - Writes findings to a deterministic UTF-8 CSV string with rule-derived metadata.

PicketGitLabCodeQualityReportWriter

Picket.Report.PicketGitLabCodeQualityReportWriter

Writes Picket findings as a GitLab Code Quality report.

Methods

• Write(IReadOnlyList<Finding> findings) - Writes findings to GitLab’s Code Quality JSON array format.

PicketHtmlReportWriter

Picket.Report.PicketHtmlReportWriter

Writes self-contained Picket-native HTML reports.

Methods

• Write(IReadOnlyList<Finding> findings, IReadOnlyList<SecretRule> rules) - Writes findings and rule metadata to a static HTML report.

PicketJsonReportWriter

Picket.Report.PicketJsonReportWriter

Writes Picket-native JSON reports with schema and rule metadata.

Methods

• Write(IReadOnlyList<Finding> findings, IReadOnlyList<SecretRule> rules, bool scanComplete) - Writes findings and rule metadata to a deterministic JSON report.

PicketJsonlReportWriter

Picket.Report.PicketJsonlReportWriter

Writes Picket-native JSON Lines reports with one finding per line.

Methods

• Write(IReadOnlyList<Finding> findings) - Writes findings to compact JSON Lines.
• Write(IReadOnlyList<Finding> findings, IReadOnlyList<SecretRule> rules) - Writes findings to compact JSON Lines with rule-derived metadata.

PicketJunitReportWriter

Picket.Report.PicketJunitReportWriter

Writes Picket-native JUnit XML reports.

Methods

• Write(IReadOnlyList<Finding> findings) - Writes findings to a deterministic UTF-8 JUnit XML string.
• Write(IReadOnlyList<Finding> findings, IReadOnlyList<SecretRule> rules) - Writes findings to a deterministic UTF-8 JUnit XML string with rule-derived metadata.

PicketSarifReportWriter

Picket.Report.PicketSarifReportWriter

Writes Picket-native SARIF 2.1.0 reports for code-scanning systems.

Methods

• Write(IReadOnlyList<Finding> findings, IReadOnlyList<SecretRule> rules, bool scanComplete) - Writes findings and ordered rules to a deterministic SARIF JSON string.

PicketToonReportWriter

Picket.Report.PicketToonReportWriter

Writes Picket-native TOON reports for compact LLM-oriented triage.

Methods

• Write(IReadOnlyList<Finding> findings, IReadOnlyList<SecretRule> rules) - Writes findings and rule metadata to a deterministic TOON report.

ReportFindingReader

Picket.Report.ReportFindingReader

Reads finding records from reports that preserve raw secret material.

Methods

• TryRead(string path, out List<Finding> findings) - Attempts to read findings from a supported report file.

ReportFindingSummary

Picket.Report.ReportFindingSummary

Represents the non-secret fields needed to triage a report finding.

Constructors

ReportFindingSummary(...)

ReportFindingSummary(
    string ruleId,
    string path,
    int line,
    string fingerprint,
    int startColumn,
    double? randomnessScore,
    string randomnessClassification,
    string randomnessModel,
    string severity,
    string confidence,
    string validationState,
    string commit,
    string author
)

Represents the non-secret fields needed to triage a report finding.

Properties

• Author - Gets the source commit author, or an empty string when unavailable.
• Commit - Gets the source commit identifier, or an empty string when unavailable.
• Confidence - Gets the finding confidence, or an empty string when unavailable.
• Fingerprint - Gets the stable fingerprint associated with the finding, or an empty string when unavailable.
• Line - Gets the one-based start line for the finding, or zero when unavailable.
• Path - Gets the reported path for the finding.
• RandomnessClassification - Gets the native randomness classification, or an empty string when unavailable.
• RandomnessModel - Gets the native randomness model identifier, or an empty string when unavailable.
• RandomnessScore - Gets the native randomness score, or when unavailable.
• RuleId - Gets the rule identifier associated with the finding.
• Severity - Gets the finding severity, or an empty string when unavailable.
• StartColumn - Gets the one-based start column for the finding, or zero when unavailable.
• ValidationState - Gets the credential validation state, or an empty string when unavailable.

ReportSummary

Picket.Report.ReportSummary

Represents a non-secret summary of a secrets report.

Constructors

• ReportSummary(string format, IReadOnlyList<ReportFindingSummary> findings) - Represents a non-secret summary of a secrets report.

Properties

• FileCount - Gets the number of distinct reported files in the report.
• FindingCount - Gets the number of findings in the report.
• Findings - Gets the non-secret finding summaries.
• Format - Gets the detected report format.

ReportSummaryReader

Picket.Report.ReportSummaryReader

Reads non-secret summaries from Picket, Gitleaks, and SARIF report files.

Methods

• Read(string path) - Reads a non-secret summary from a report file.