]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-hook.txt
Merge branch 'jc/retire-cas-opt-name-constant'
[thirdparty/git.git] / Documentation / git-hook.txt
CommitLineData
96e7225b
ES
1git-hook(1)
2===========
3
4NAME
5----
6git-hook - Run git hooks
7
8SYNOPSIS
9--------
10[verse]
0414b389 11'git hook' run [--ignore-missing] [--to-stdin=<path>] <hook-name> [-- <hook-args>]
96e7225b
ES
12
13DESCRIPTION
14-----------
15
9a9fd289 16A command interface for running git hooks (see linkgit:githooks[5]),
96e7225b
ES
17for use by other scripted git commands.
18
19SUBCOMMANDS
20-----------
21
22run::
23 Run the `<hook-name>` hook. See linkgit:githooks[5] for
24 supported hook names.
25+
26
27Any positional arguments to the hook should be passed after a
28mandatory `--` (or `--end-of-options`, see linkgit:gitcli[7]). See
29linkgit:githooks[5] for arguments hooks might expect (if any).
30
0d3979c1
ÆAB
31OPTIONS
32-------
33
0414b389 34--to-stdin::
2150b6fb 35 For "run"; specify a file which will be streamed into the
0414b389
ES
36 hook's stdin. The hook will receive the entire file from
37 beginning to EOF.
38
0d3979c1
ÆAB
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
96e7225b
ES
44SEE ALSO
45--------
46linkgit:githooks[5]
47
48GIT
49---
50Part of the linkgit:git[1] suite