ggshield secret scan pre-receive

Description

Scan as a pre-receive git hook all commits about to enter the remote git repository.

ggshield secret scan pre-receive [OPTIONS] [PRERECEIVE_ARGS]...

Options

• --with-incident-details: Display full details about the dashboard incident if one is found (JSON and SARIF formats only).
• -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-receive integration with ggshield.