Getting Started

Goat Hooker is a CLI tool for creating, managing and executing Git Hooks on any project (including monorepos). It also solves the problem of sharing hooks between different contributors by using explicit configuration files to generate hooks. It also offers pre-made hooks that can be imported into configuration files and configured using a few parameters.

Quick start

Installation

Install Goat Hooker by running the following commands in your terminal:

Step 1

git clone https://github.com/zuygui/goat-hooker

Step 2

cargo build --release

Step 3

export PATH=$PATH:$(pwd)/target/release

Danger

Remember that the program executable is here and that if you delete the cloned folder, the program will also be deleted and thus unusable.

Tip

The project is still on development and a more easy way to install is planed. Just wait for a release to get final installation instructions.

Create a configuration file

Goat hooker has a tool to generate a basic configuration file. To generate it, just run this command is a bash terminal:

hooker init

If you wanna do it mannually, you can create a file called hooker.config.yaml and fill it with these informations:

hooks:

Run all your hooks

With Goat Hooker, everything is easy to do, so, to run your hooks, just run this command in your shell:

hooker run all