GITHOOKS(1)

💖 GITHOOKS(1) 💖

okay bestie, welcome to the githooks manual page, straight out of the User Contributed Perl Documentation section of your friendly neighbourhood man pages. this is the setup utility for App::GitHooks, and yes it's about to make your git hooks behave 💅

---

✨ NAME ✨

githooks — setup utility for App::GitHooks. that's it, that's the name, she's simple and she knows what she wants 🎀

🦋 VERSION 🦋

Version 1.9.0 — the glow-up era, we love to see it ✨

🌸 DESCRIPTION 🌸

so basically, this command line utility lets you set up git hooks in the current git repository, so that all of App::GitHooks' hooks are triggered properly. that's the whole vibe: you run it, your repo gets its hooks, everything fires the way it's supposed to. slay 🫶

⭐ SYNOPSIS ⭐

githooks <command>

👑 COMMANDS 👑

here's the menu, no cap:

• help — shows you the commands that are available. your little map of the whole thing 🗺️
• install — installs all the git hooks for the current repository. go off, get those hooks in 🎀
• list — lists the plugins that are currently installed. inventory check, bestie 🧚
• uninstall — removes all the git hooks for the current repository. it's giving spring cleaning 💀
• version — displays the version of App::GitHooks that's in use. who are you talking to, exactly? this tells you ✨

💅 OPTIONS 💅

• --chmod — the chmod to use for the git hooks. default is 755, and yes that default is iconic and you should probably just leave it alone 😌

🧚 FUNCTIONS 🧚

usage()

Displays the usage information on the command line and forces exit. it does not ask permission, it simply leaves 🚪💨

usage();

uninstall()

Removes git hooks triggering App::GitHooks from the current git repository. bye bye hooks 🫶

uninstall();

install()

Installs git hooks triggering App::GitHooks for the current git repository. hello hooks 🎀

install();

version()

Displays the version of App::GitHooks in use. the classic identity check ✨

version();

list()

Lists the plugins that are currently installed. show me what you've got 👑

list();

🔒 PRIVATE FUNCTIONS 🔒

get_hooks_directory()

Returns the path to the hooks directory for the current git repository. she knows where everything lives, lowkey the most useful one here 🗂️

my $hooks_directory = get_hooks_directory();

💀 BUGS 💀

found a bug or want a new feature? please report it through the web interface at <https://github.com/guillaumeaubert/App-GitHooks/issues/new>. the author gets notified, and then you automatically get notified of progress on your bug as changes are made. it's a whole little notification relationship, fr fr 📬

🫶 SUPPORT 🫶

you can find documentation for this module with the perldoc command. no cap, that's the move:

perldoc App::GitHooks

you can also look for information at:

• GitHub's request tracker

<https://github.com/guillaumeaubert/App-GitHooks/issues>

• AnnoCPAN: Annotated CPAN documentation

<http://annocpan.org/dist/app-githooks>

• CPAN Ratings

<http://cpanratings.perl.org/d/app-githooks>

• MetaCPAN

<https://metacpan.org/release/App-GitHooks>

🌈 AUTHOR 🌈

Guillaume Aubert <https://metacpan.org/author/AUBERTG>, "<aubertg at cpan.org>". legend behaviour 👑

📜 COPYRIGHT & LICENSE 📜

Copyright 2013-2017 Guillaume Aubert.

This code is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details. (yes bestie, that's the scary all-caps part, it means exactly what it says — no promises, read the LICENSE 🙈)

---

🎀 NAME (the hook edition) 🎀

{{name}} — call App::GitHooks for the {{name}} hook. that placeholder is doing main character energy, iykyk ✨

---

and that's the whole page, bestie!! this gem is perl v5.42.0 flavoured, dated 2025-07-25, and it's the GITHOOKS(1) manual page through and through. now go install some hooks and ate 💅🌸💖