Difference between revisions of "Pre-commit --help"
Jump to navigation
Jump to search
(Created page with "{{lc}} == See also == * {{pre-commit}} Category:pre-commit Category:Git") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{lc}} | {{lc}} | ||
| + | |||
| + | usage: [[pre-commit]] [-h] [-V] | ||
| + | <pre> | ||
| + | {autoupdate,clean,gc,init-templatedir,install,install-hooks,migrate-config,run,sample-config,try-repo,uninstall,validate-config,validate-manifest,help,hook-impl} | ||
| + | ... | ||
| + | |||
| + | positional arguments: | ||
| + | {autoupdate,clean,gc,init-templatedir,install,install-hooks,migrate-config,run,sample-config,try-repo,uninstall,validate-config,validate-manifest,help,hook-impl} | ||
| + | autoupdate Auto-update pre-commit config | ||
| + | to the latest repos' versions. | ||
| + | clean Clean out pre-commit files. | ||
| + | gc Clean unused cached repos. | ||
| + | init-templatedir Install hook script in a | ||
| + | directory intended for use with | ||
| + | `git config init.templateDir`. | ||
| + | install Install the pre-commit script. | ||
| + | install-hooks Install hook environments for | ||
| + | all environments in the config | ||
| + | file. You may find `pre-commit | ||
| + | install --install-hooks` more | ||
| + | useful. | ||
| + | migrate-config Migrate list configuration to | ||
| + | new map configuration. | ||
| + | run Run hooks. | ||
| + | sample-config Produce a sample .pre-commit- | ||
| + | config.yaml file | ||
| + | try-repo Try the hooks in a repository, | ||
| + | useful for developing new | ||
| + | hooks. | ||
| + | uninstall Uninstall the pre-commit | ||
| + | script. | ||
| + | validate-config Validate .pre-commit- | ||
| + | config.yaml files | ||
| + | validate-manifest Validate .pre-commit-hooks.yaml | ||
| + | files | ||
| + | help Show help for a specific | ||
| + | command. | ||
| + | |||
| + | options: | ||
| + | -h, --help show this help message and exit | ||
| + | -V, --version show program's version number | ||
| + | and exit | ||
| + | </pre> | ||
Latest revision as of 17:51, 28 February 2023
usage: pre-commit [-h] [-V]
{autoupdate,clean,gc,init-templatedir,install,install-hooks,migrate-config,run,sample-config,try-repo,uninstall,validate-config,validate-manifest,help,hook-impl}
...
positional arguments:
{autoupdate,clean,gc,init-templatedir,install,install-hooks,migrate-config,run,sample-config,try-repo,uninstall,validate-config,validate-manifest,help,hook-impl}
autoupdate Auto-update pre-commit config
to the latest repos' versions.
clean Clean out pre-commit files.
gc Clean unused cached repos.
init-templatedir Install hook script in a
directory intended for use with
`git config init.templateDir`.
install Install the pre-commit script.
install-hooks Install hook environments for
all environments in the config
file. You may find `pre-commit
install --install-hooks` more
useful.
migrate-config Migrate list configuration to
new map configuration.
run Run hooks.
sample-config Produce a sample .pre-commit-
config.yaml file
try-repo Try the hooks in a repository,
useful for developing new
hooks.
uninstall Uninstall the pre-commit
script.
validate-config Validate .pre-commit-
config.yaml files
validate-manifest Validate .pre-commit-hooks.yaml
files
help Show help for a specific
command.
options:
-h, --help show this help message and exit
-V, --version show program's version number
and exit
See also[edit]
Advertising: