ggshield secret scan docset

Description

Scan docset JSONL files.

ggshield secret scan docset [OPTIONS] FILES...

The JSONL files must be formatted using the "Docset" format.

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.

Examples

# scan file1.jsonl and file2.jsonl for secrets
$ ggshield secret scan docset file1.jsonl file2.jsonl