Skip to main content

ggshield secret scan pre-push

Description

Scan as a pre-push git hook all commits that are about to be pushed.

ggshield secret scan pre-push [OPTIONS] [PREPUSH_ARGS]...

Options

  • --instance URL: URL of the instance to use.
  • --with-incident-details: Display full details about the dashboard incident if one is found (JSON and SARIF formats only). Requires the 'incidents:read' scope.
  • -b, --banlist-detector DETECTOR: Exclude results from a detector.
  • --ignore-known-secrets: Ignore secrets already known by GitGuardian dashboard.
  • --exclude PATTERNS: Do not scan paths that match the specified glob-like patterns.
  • --exit-zero: Always return a 0 (non-error) status code, even if incidents are found. This option can also be set with the GITGUARDIAN_EXIT_ZERO environment variable.
  • --show-secrets: Show secrets in plaintext instead of hiding them.
  • -o, --output PATH: Redirect ggshield output to PATH.
  • --format [text|json|sarif]: Format to use for the output.
  • --json: Shorthand for --format json.

This command supports all ggshield global options.

See also

Go to our dedicated documentation for more details about pre-push integration with ggshield.

How can I help you ?