ggshield secret scan pre-commit

Description

Scan as a pre-commit hook all changes that have been staged in a git repository.

ggshield secret scan pre-commit [OPTIONS] [PRECOMMIT_ARGS]...

Options

• --scan-all-merge-files: When scanning a merge commit, scan all files, including those that merged without conflicts.
• --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-commit integration with ggshield.