Setup Git Hooks

Install Git Hooks Toolbox subhooks into a local clone. Each repo lists hook sources in hooks/<type>-config.yml. Running setup-hooks fetches src/<type> from those remotes and writes hooks/<type>/01-<filename>. The multiplexer is installed into .git/hooks/<type> unless you skip it.

Install

Python 3.13 or newer.

python -m pip install lupaxa-setup-git-hooks

From this checkout:

python -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
make init

Run

From the consuming repository root:

setup-hooks
setup-hooks --force
setup-hooks --skip-multiplexer
setup-hooks --skip-gitignore
setup-hooks -t pre-commit

hooks/multiplexer-config.yml is required unless --skip-multiplexer. Each hook updates one line from Installing ... -> <path> to Installed ... (cyan spinner, yellow then green on a TTY). Generated scripts are not committed. Re-run with --force to replace them.

Documentation

The guide is in mkdocs/. After installing the dev extras:

make mkdocs-serve