1GITHOOKS(1)           User Contributed Perl Documentation          GITHOOKS(1)
2
3
4

NAME

6       githooks - Setup utility for App::GitHooks
7

VERSION

9       Version 1.9.0
10

DESCRIPTION

12       This command line utility allows setting up git hooks in the current
13       git repository, so that all of App::GitHooks' hooks are triggered
14       properly.
15

SYNOPSIS

17               githooks <command>
18

COMMANDS

20       •   "help" - Show the commands available.
21
22       •   "install" - Install all the git hooks for the current repository.
23
24       •   "list" - List the plugins currently installed.
25
26       •   "uninstall" - Remove all the git hooks for the current repository.
27
28       •   "version" - Display the version of App::GitHooks in use.
29

OPTIONS

31       •   "--chmod" - Chmod to use for the git hooks (default: 755).
32

FUNCTIONS

34   usage()
35       Display the usage information on the command line and force exit.
36
37               usage();
38
39   uninstall()
40       Remove git hooks triggering App::GitHooks from the current git
41       repository.
42
43               uninstall();
44
45   install()
46       Install git hooks triggering App::GitHooks for the current git
47       repository.
48
49               install();
50
51   version()
52       Display the version of App::GitHooks in use.
53
54               version();
55
56   list()
57       List the plugins currently installed.
58
59               list();
60

PRIVATE FUNCTIONS

62   get_hooks_directory()
63       Return the path to the hooks directory for the current git repository.
64
65               my $hooks_directory = get_hooks_directory();
66

BUGS

68       Please report any bugs or feature requests through the web interface at
69       <https://github.com/guillaumeaubert/App-GitHooks/issues/new>.  I will
70       be notified, and then you'll automatically be notified of progress on
71       your bug as I make changes.
72

SUPPORT

74       You can find documentation for this module with the perldoc command.
75
76               perldoc App::GitHooks
77
78       You can also look for information at:
79
80       •   GitHub's request tracker
81
82           <https://github.com/guillaumeaubert/App-GitHooks/issues>
83
84       •   AnnoCPAN: Annotated CPAN documentation
85
86           <http://annocpan.org/dist/app-githooks>
87
88       •   CPAN Ratings
89
90           <http://cpanratings.perl.org/d/app-githooks>
91
92       •   MetaCPAN
93
94           <https://metacpan.org/release/App-GitHooks>
95

AUTHOR

97       Guillaume Aubert <https://metacpan.org/author/AUBERTG>, "<aubertg at
98       cpan.org>".
99

101       Copyright 2013-2017 Guillaume Aubert.
102
103       This code is free software; you can redistribute it and/or modify it
104       under the same terms as Perl 5 itself.
105
106       This program is distributed in the hope that it will be useful, but
107       WITHOUT ANY WARRANTY; without even the implied warranty of
108       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE
109       file for more details.
110

NAME

112       {{name}} - Call App::GitHooks for the {{name}} hook.
113
114
115
116perl v5.38.0                      2023-07-20                       GITHOOKS(1)
Impressum