26 lines
833 B
Markdown
26 lines
833 B
Markdown
# pinch
|
|
|
|
*A pinch of Git ~~pinches~~ hooks*
|
|
|
|
Pinch is a global Git hook manager. Its main use is to establish a modular hook system.
|
|
|
|
## Requirements
|
|
|
|
- A mostly POSIX-compatible OS
|
|
- Bash >= 5.0
|
|
- Busybox, Coreutils or alternatives
|
|
- Git >= 2.9
|
|
|
|
## Installation
|
|
|
|
To install pinch, clone this repository and execute **[install.sh](install.sh)**. If there is different global hook configuration, pinch will remember it.
|
|
|
|
Similarly, in order to uninstall pinch, execute **[uninstall.sh](uninstall.sh)**. Previous configuration (if there was any) will be restored.
|
|
|
|
## Debug mode
|
|
|
|
In order to enable debug messages, set `PINCH_DEBUG` to `1` as an environment variable before invoking Git hooks.
|
|
|
|
## License
|
|
|
|
pinch is a free and open-source program distributed under the terms of the [MIT license](https://opensource.org/licenses/MIT).
|