Skip to content

githooks hook

Install or remove git hooks.

Install hooks

githooks hook [options]

For each event defined in the hooks section of the configuration, GitHooks:

  1. Creates a .githooks/<event> script file.
  2. Runs git config core.hooksPath .githooks.

The generated scripts are universal and identical — each one calls githooks hook:run <event>, which resolves the event to its configured flows/jobs. The command prefix is taken from hooks.command in the config (defaults to php vendor/bin/githooks).

githooks hook                  # Install all configured hooks
githooks hook --legacy         # Install pre-commit in .git/hooks/ (Git < 2.9)
githooks hook pre-push --legacy  # Install specific hook in .git/hooks/

Tip

The .githooks/ directory should be committed to version control. The scripts are universal — they never need to be regenerated after config changes.

Legacy mode

The --legacy flag installs hooks by copying a script to .git/hooks/. This is needed for environments with Git < 2.9 which does not support core.hooksPath. You can also pass a custom script file:

githooks hook pre-commit MyCustomPrecommit.php --legacy

Remove hooks

githooks hook:clean [options]

githooks hook:clean                     # Remove .githooks/ + unset core.hooksPath
githooks hook:clean --legacy            # Remove pre-commit from .git/hooks/
githooks hook:clean pre-push --legacy   # Remove specific hook from .git/hooks/

Without --legacy, removes the entire .githooks/ directory and unsets core.hooksPath. With --legacy, removes individual hooks from .git/hooks/.

Internal: hook:run

githooks hook:run <event>

Executes all flows and jobs associated with a git hook event. This is the command that the universal hook script calls internally — you normally don't need to run it manually.

For pre-commit events, fast mode is activated automatically.

See also