Skip to main content

ggshield secret scan pypi


Scan a pypi package.

ggshield secret scan pypi [OPTIONS] PACKAGE_NAME

Under the hood this command uses the pip download command to download the python package.

You can use pip environment variables or configuration files to set pip download parameters as explained in pip documentation. For example, you can set pip --index-url parameter with the PIP_INDEX_URL environment variable.


  • -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.
  • --json: Use JSON output.

This command supports all ggshield global options.

How can I help you ?