pre-commit-install - Man Page
pre-commit-install – Install the pre-commit script
Synopsis
pre-commit install [-h] [--color {auto,always,never}] [-c CONFIG] [-f] [--install-hooks] [-t {commit-msg,post-checkout,post-commit,post-merge,post-rewrite,pre-commit,pre-merge-commit,pre-push,pre-rebase,prepare-commit-msg}] [--allow-missing-config]
Options
Optional Arguments
- -h, --help
Show a help message and exit.
- --color {auto,always,never}
Whether to use color in output. Defaults to auto.
- -c, --config CONFIG
Path to alternate config file.
- -f, --overwrite
Overwrite existing hooks / remove migration mode.
- --install-hooks
Whether to install hook environments for all environments in the config file.
- -t, --hook-type {commit-msg,post-checkout,post-commit,post-merge,post-rewrite,pre-commit,pre-merge-commit,pre-push,pre-rebase,prepare-commit-msg}
- --allow-missing-config
Whether to allow a missing pre-commit configuration file or exit with a failure code.
See Also
pre-commit-autoupdate(1), pre-commit-clean(1), pre-commit-gc(1), pre-commit-init-templatedir(1), pre-commit-install-hooks(1), pre-commit-migrate-config(1), pre-commit-run(1), pre-commit-sample-config(1), pre-commit-try-repo(1), pre-commit-uninstall(1), pre-commit-validate-config(1), pre-commit-validate-manifest(1), pre-commit-help(1)
Referenced By
pre-commit(1), pre-commit-autoupdate(1), pre-commit-clean(1), pre-commit-gc(1), pre-commit-help(1), pre-commit-init-templatedir(1), pre-commit-install-hooks(1), pre-commit-migrate-config(1), pre-commit-run(1), pre-commit-sample-config(1), pre-commit-try-repo(1), pre-commit-uninstall(1), pre-commit-validate-config(1), pre-commit-validate-manifest(1).