pre-commit run [hook]

Run hooks

Arguments

NameDescription
hookA single hook-id to run

Options

NameDescription
-h, --helpShow help message and exit
--color <color>Whether to use color in output. Defaults to `auto`
--config, -c <CONFIG>Path to alternate config file
--verbose, -v
--all-files, -aRun all files in the repo
--files <FILES...>Specific filenames to run hooks on
--show-diff-on-failureWhen hooks fail, run `git diff` directly afterward
--hook-stage <arg>The stage during which the hook is fired
--remote-branch <REMOTE_BRANCH>Remote branch ref used by `git push`
--local-branch <LOCAL_BRANCH>Local branch ref used by `git push`
--from-ref, --source, -s <FROM_REF>Represents the original ref in a `from_ref...to_ref` diff expression. For `pre-push` hooks, this represents the branch you are pushing to. For `post-checkout` hooks, this represents the branch that was previously checked out
--to-ref, --origin, -o <TO_REF>Represents the destination ref in a `from_ref...to_ref` diff expression. For `pre-push` hooks, this represents the branch being pushed. For `post-checkout` hooks, this represents the branch that is now checked out
--commit-msg-filename <COMMIT_MSG_FILENAME>Filename to check when running during `commit-msg`
--remote-name <REMOTE_NAME>Remote name used by `git push`
--remote-url <REMOTE_URL>Remote URL used by `git push`
--checkout-type <CHECKOUT_TYPE>Indicates whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0)
--is-squash-merge <IS_SQUASH_MERGE>During a post-merge hook, indicates whether the merge was a squash merge
--rewrite-command <REWRITE_COMMAND>During a post-rewrite hook, specifies the command that invoked the rewrite