Skip to main content

Install

The install command allows you to use ggshield as a pre-commit hook on your machine, either locally or globally for all repositories.

Usage: ggshield install [OPTIONS]
  Command to install a pre-commit hook (local or global).
Options:  -m, --mode [local|global]  Hook installation mode  [required]  -f, --force                Force override  -h, --help                 Show this message and exit.

Go to our dedicated documentation for more details about pre-commit integration with gg-shield.