man1/git-hook.1

   1 '\" t
   2 .\"     Title: git-hook
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-08-14
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.0.164.g477ce5ccd6
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-HOOK" "1" "2024-08-14" "Git 2\&.46\&.0\&.164\&.g477ce5" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-hook \- Run git hooks
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit hook\fR run [\-\-ignore\-missing] [\-\-to\-stdin=<path>] <hook\-name> [\-\- <hook\-args>]
  36 .fi
  37 .SH "DESCRIPTION"
  38 .sp
  39 A command interface for running git hooks (see \fBgithooks\fR(5)), for use by other scripted git commands\&.
  40 .SH "SUBCOMMANDS"
  41 .PP
  42 run
  43 .RS 4
  44 Run the
  45 \fB<hook\-name>\fR
  46 hook\&. See
  47 \fBgithooks\fR(5)
  48 for supported hook names\&.
  49 .sp
  50 Any positional arguments to the hook should be passed after a mandatory
  51 \fB\-\-\fR
  52 (or
  53 \fB\-\-end\-of\-options\fR, see
  54 \fBgitcli\fR(7))\&. See
  55 \fBgithooks\fR(5)
  56 for arguments hooks might expect (if any)\&.
  57 .RE
  58 .SH "OPTIONS"
  59 .PP
  60 \-\-to\-stdin
  61 .RS 4
  62 For "run"; specify a file which will be streamed into the hook\(cqs stdin\&. The hook will receive the entire file from beginning to EOF\&.
  63 .RE
  64 .PP
  65 \-\-ignore\-missing
  66 .RS 4
  67 Ignore any missing hook by quietly returning zero\&. Used for tools that want to do a blind one\-shot run of a hook that may or may not be present\&.
  68 .RE
  69 .SH "SEE ALSO"
  70 .sp
  71 \fBgithooks\fR(5)
  72 .SH "GIT"
  73 .sp
  74 Part of the \fBgit\fR(1) suite