githooks

GITHOOKS(1)           User Contributed Perl Documentation          GITHOOKS(1)



NAME
       githooks - Setup utility for App::GitHooks

VERSION
       Version 1.9.0

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

SYNOPSIS
               githooks <command>

COMMANDS
       ·   "help" - Show the commands available.

       ·   "install" - Install all the git hooks for the current repository.

       ·   "list" - List the plugins currently installed.

       ·   "uninstall" - Remove all the git hooks for the current repository.

       ·   "version" - Display the version of App::GitHooks in use.

OPTIONS
       ·   "--chmod" - Chmod to use for the git hooks (default: 755).

FUNCTIONS
   usage()
       Display the usage information on the command line and force exit.

               usage();

   uninstall()
       Remove git hooks triggering App::GitHooks from the current git
       repository.

               uninstall();

   install()
       Install git hooks triggering App::GitHooks for the current git
       repository.

               install();

   version()
       Display the version of App::GitHooks in use.

               version();

   list()
       List the plugins currently installed.

               list();

PRIVATE FUNCTIONS
   get_hooks_directory()
       Return the path to the hooks directory for the current git repository.

               my $hooks_directory = get_hooks_directory();

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

SUPPORT
       You can find documentation for this module with the perldoc command.

               perldoc App::GitHooks

       You can also look for information at:

       ·   GitHub's request tracker

           <https://github.com/guillaumeaubert/App-GitHooks/issues>

       ·   AnnoCPAN: Annotated CPAN documentation

           <http://annocpan.org/dist/app-githooks>

       ·   CPAN Ratings

           <http://cpanratings.perl.org/d/app-githooks>

       ·   MetaCPAN

           <https://metacpan.org/release/App-GitHooks>

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

COPYRIGHT & LICENSE
       Copyright 2013-2017 Guillaume Aubert.

       This code is free software; you can redistribute it and/or modify it
       under the same terms as Perl 5 itself.

       This program is distributed in the hope that it will be useful, but
       WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE
       file for more details.

NAME
       {{name}} - Call App::GitHooks for the {{name}} hook.



perl v5.28.1                      2019-02-02                       GITHOOKS(1)