Documentation/git-hook.txt

   1 git-hook(1)
   2 ===========
   3
   4 NAME
   5 ----
   6 git-hook - Run git hooks
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'git hook' run [--ignore-missing] [--to-stdin=<path>] <hook-name> [-- <hook-args>]
  12
  13 DESCRIPTION
  14 -----------
  15
  16 A command interface for running git hooks (see linkgit:githooks[5]),
  17 for use by other scripted git commands.
  18
  19 SUBCOMMANDS
  20 -----------
  21
  22 run::
  23         Run the `<hook-name>` hook. See linkgit:githooks[5] for
  24         supported hook names.
  25 +
  26
  27 Any positional arguments to the hook should be passed after a
  28 mandatory `--` (or `--end-of-options`, see linkgit:gitcli[7]). See
  29 linkgit:githooks[5] for arguments hooks might expect (if any).
  30
  31 OPTIONS
  32 -------
  33
  34 --to-stdin::
  35         For "run"; specify a file which will be streamed into the
  36         hook's stdin. The hook will receive the entire file from
  37         beginning to EOF.
  38
  39 --ignore-missing::
  40         Ignore any missing hook by quietly returning zero. Used for
  41         tools that want to do a blind one-shot run of a hook that may
  42         or may not be present.
  43
  44 SEE ALSO
  45 --------
  46 linkgit:githooks[5]
  47
  48 GIT
  49 ---
  50 Part of the linkgit:git[1] suite