Skip to main content

ggshield secret scan repo

Description#

Scan all commits across all git branches in a git repository at a given URL or path.

ggshield secret scan repo [OPTIONS] <REPOSITORY>

<REPOSITORY> is the clone URI or the path of the repository to scan.

Options#

No options

ggshield global options#

  • -h, --help: display detailed help
  • --json: output results in JSON [default:false]

Examples#

# scan a repository with its clone URI$ ggshield secret scan repo git@github.com:GitGuardian/ggshield.git
# scan a repository with its path$ ggshield secret scan repo /repositories/ggshield

See also#

It is best to use a native VCS integration and view the results of a scan within the dashboard.