hooked/hooked-book/source
Bauke 4a4974fa35
Add git_staged documentation.
2022-11-20 13:07:32 +01:00
..
changelog Add the deploy task and mdBook. 2022-11-03 13:59:53 +01:00
cli Use the generate CLI reference. 2022-11-06 18:46:28 +01:00
configuration Add git_staged documentation. 2022-11-20 13:07:32 +01:00
getting-started Add the .deb installation section. 2022-11-03 14:16:40 +01:00
README.md Add the deploy task and mdBook. 2022-11-03 13:59:53 +01:00
SUMMARY.md Add the deploy task and mdBook. 2022-11-03 13:59:53 +01:00
cli-reference.txt Use the generate CLI reference. 2022-11-06 18:46:28 +01:00

README.md

Hooked 🪝

# Hooked.toml
[[pre_commit]]
name = "Cargo Check"
command = "cargo check"
# Install Hooked to ".git/hooks".
$ hooked install

# Commit away!
$ git commit -m 'Start using Hooked!'
Hooked: Running 1 pre-commit hook.
	✓ Cargo Check
[main b386e59] Start using Hooked!
 1 file changed, 3 insertions(+)
 create mode 100644 Hooked.toml

Hooked is a manager for Git hooks. It is language-agnostic (not built for any specific language or ecosystem), has a low barrier to entry (hooks can be one-liners in a configuration file) and is extensible (most of what Hooked does can be replaced through its configuration).

If you've been convinced and would like to give it a shot, Getting Started is the place to be.