Skip to content

feat: document stdout report path#1990

Merged
zricethezav merged 1 commit intogitleaks:masterfrom
rgmz:docs/stdout-report
Nov 17, 2025
Merged

feat: document stdout report path#1990
zricethezav merged 1 commit intogitleaks:masterfrom
rgmz:docs/stdout-report

Conversation

@rgmz
Copy link
Contributor

@rgmz rgmz commented Nov 17, 2025

Description:

#1642 added a great feature where the report can be sent to stdout. This should be included in --help for visibility.

$ go run . --help
Gitleaks scans code, past or present, for secrets

Usage:
  gitleaks [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  dir         scan directories or files for secrets
  git         scan git repositories for secrets
  help        Help about any command
  stdin       detect secrets from stdin
  version     display gitleaks version

Flags:
  ...
  -f, --report-format string          output format (json, csv, junit, sarif, template)
  -r, --report-path string            report file (use "-" for stdout)
  ...

Related: #187 (comment)

Checklist:

  • Does your PR pass tests?
  • Have you written new tests for your changes?
  • Have you lint your code locally prior to submission?

@zricethezav
Copy link
Collaborator

👍🏻

@zricethezav zricethezav merged commit 50493db into gitleaks:master Nov 17, 2025
2 checks passed
@rgmz rgmz deleted the docs/stdout-report branch November 17, 2025 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants