hookman

Add hooks to your Git repository using a TOML file.

[!IMPORTANT] If you like this project, consider starring! ⭐ It's free, and it always motivates me to make more of such projects. :D

Table of Contents

• Usage
• Installation
• Contributing
• License

Usage

Using hookman is pretty straightforward.

When inside the directory of a Git repository, create a new hookman.toml with the following structure:

# structure:
[hook.<event>]  # here "event" is the event for running the hook
run = "<command>"  # and here is your actual shell command

# example:
[hook.pre-commit]
run = "pip install -U -r requirements.txt && pip list > requirements.txt"

1. To put your hooks into action, run:

hookman build

2. To list all installed hooks, run:

hookman list

3. To list all possible events a hook can be attached to, run:

hookman list-events

4. And, to remove/clean all hooks:

hookman clean

Installation

Install using cargo:

cargo install hookman

Contributing

hookman is a very tiny project for those who'd like to use an extremely minimal setup for managing git hooks, so I don't think there is a need to follow a mandatory set of rules for contribution. Anyhow, pull requests, and new issues regarding feature suggestions, bug fixes or new ideas are always welcome!

License

Licensed under the MIT License. Please check LICENSE for more information.