Skip to main content

ggshield install

Description#

The install command installs ggshield as a git pre-commit or pre-push hook, either for the current repository (locally) or for all repositories (globally).

ggshield install [OPTIONS]

Options#

  • -a, --append: append to existing script
  • -m, --mode [local|global]: hook installation mode [required]
  • -t, --hook-type [pre-commit|pre-push]: type of hook to install. Default is pre-commit
  • -f, --force: force override

ggshield global options#

  • -h, --help: display detailed help