git.oblomov.eu Git - git/blob - 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 [--to-stdin=<path>] [--ignore-missing] <hook-name> [-- <hook-args>]
  12
  13 DESCRIPTION
  14 -----------
  15
  16 This command is an interface to git hooks (see linkgit:githooks[5]).
  17 Currently it only provides a convenience wrapper for running hooks for
  18 use by git itself. In the future it might gain other functionality.
  19
  20 SUBCOMMANDS
  21 -----------
  22
  23 run::
  24
  25         Run the `<hook-name>` hook. Any positional arguments to the
  26         hook should be passed after an optional "--" (or
  27         "--end-of-options"). See "OPTIONS" below for the arguments
  28         this accepts.
  29
  30 OPTIONS
  31 -------
  32
  33 --to-stdin::
  34         For "run"; Specify a file which will be streamed into the
  35         hook's stdin. The hook will receive the entire file from
  36         beginning to EOF.
  37
  38 --ignore-missing::
  39         Ignore any missing hook by quietly returning zero. Used for
  40         tools that want to do a blind one-shot run of a hook that may
  41         or may not be present.
  42
  43 SEE ALSO
  44 --------
  45 linkgit:githooks[5]
  46
  47 GIT
  48 ---
  49 Part of the linkgit:git[1] suite