Git Hooks Installer

Make it easy to install git hooks to your project. After the initial setup is ran by you, others contributing to the project can install the same hooks locally by executing install-hooks.

What are Git hooks?

Git hooks are scripts that Git executes before or after events such as: commit, push, and receive. Git hooks are a built-in feature - no need to download anything. Git hooks are run locally.

You can read more about git hooks at githooks.com.

Usage

Ensure that this directory is in your path (and that the script dir is in the same directory as git-hooks-installer). Or just reference the full path:

$ git clone git@github.com:bombsimon/git-hooks-installer.git ~/git/

$ ~/git/git-hooks-installer/git-hooks-installer --help
git-hooks-installer - Install git hooks wrapper in your project!

Usage: git-hooks-installer [-f|--force] [-i|--install-path <project>] [project]

  -h|--help         : Print this help text
  -f|--force        : Don't prompt for yes/no questions, assume yes
  -i|--install-path : The path to install in (defaults to pwd)
  -s|--script-dir   : The name of the directory to use for scripts

$ ~/git/git-hooks-installer/git-hooks-installer /path/to/my/git-project
Will run git-hooks-installer in /path/to/my/git-project. Continue? [Y/n]: y
Creating script
Creating script/hook-wrapper
Creating script/install-hooks
Creating script/pre-commit

You're now all set! Commit the new directory and/or files and everyone can enjoy
the repository specific git hooks. To install the example hook (and any other
hook), run the install script in "script/install-hooks".

For a list of available git hooks, see https://githooks.com

With the script

You can now use the installer that got copied to your repo to install or uninstall hooks in the script-dir you chose (default scripts).

$ cd /path/to/my/git-project
$ ./scripts/install-hooks
Installing hooks to your project!

If you want to remove all your symbolic links created in .git/hooks and restore the hooks that got renamed, just pass the uninstall flag (-u/--uninstall).

$ ./script/install-hooks -u
Uninstalling hooks from your project!

With Git

Since git will call executables prefixed with git- in your path you can use this as a git command if you're located in the root of a git repository.

$ export="$PATH:/path/to/git-hooks-installer"
$ cd /path/to/my/git-project
$ git hooks-installer
Will run git-hooks-installer in [...]

Examples

There's an example folder with example hooks. Feel free to use and/or add new hooks which might be useful.

An example hook will be be added to your project which you may remove.