CLI Reference &para;

--allow-missing-config

Include the specified hooks or projects.

Supports flexible selector syntax:

hook-id: Run all hooks with the specified ID across all projects
project-path/: Run all hooks from the specified project
project-path:hook-id: Run only the specified hook from the specified project

Can be specified multiple times to select multiple hooks/projects.

Options

Allow a missing configuration file

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--force, --overwrite, -f

Force installation and overwrite existing Git shims.

If core.hooksPath is configured outside this repository, install the shims into this repository's default hooks directory.

--git-dir git-dir

Install Git shims into the hooks subdirectory of the given git directory (<GIT_DIR>/hooks/).

When this flag is used, prek install bypasses the safety check that normally refuses to install shims while core.hooksPath is configured outside the repo. It only writes shims to <GIT_DIR>/hooks; Git will keep using core.hooksPath until that config changes.

--help, -h

Display the concise help for this command

--hook-type, -t hook-type

Which Git shim(s) to install.

Specifies which Git hook type(s) you want to install shims for. Can be specified multiple times to install shims for multiple hook types.

If not specified, uses default_install_hook_types from the config file, or defaults to pre-commit if that is also not set.

Note: This is different from a hook's stages parameter in the config file, which declares which stages a hook can run in.

Possible values:

commit-msg
post-checkout
post-commit
post-merge
post-rewrite
pre-commit
pre-merge-commit
pre-push
pre-rebase
prepare-commit-msg

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--prepare-hooks, --install-hooks

Also prepare environments for all hooks used in the config file

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--skip hook|project

Skip the specified hooks or projects.

Supports flexible selector syntax:

hook-id: Skip all hooks with the specified ID across all projects
project-path/: Skip all hooks from the specified project
project-path:hook-id: Skip only the specified hook from the specified project

Can be specified multiple times. Also accepts PREK_SKIP or SKIP environment variables (comma-delimited).

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek prepare-hooks¶

Prepare environments for configured hooks.

This command does not install Git shims. To install the Git shims along with the hook environments in one command, use prek install --prepare-hooks.

Usage

prek prepare-hooks [OPTIONS] [HOOK|PROJECT]...

Arguments

Include the specified hooks or projects.

Supports flexible selector syntax:

hook-id: Run all hooks with the specified ID across all projects
project-path/: Run all hooks from the specified project
project-path:hook-id: Run only the specified hook from the specified project

Can be specified multiple times to select multiple hooks/projects.

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--help, -h

Display the concise help for this command

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--skip hook|project

Skip the specified hooks or projects.

Supports flexible selector syntax:

hook-id: Skip all hooks with the specified ID across all projects
project-path/: Skip all hooks from the specified project
project-path:hook-id: Skip only the specified hook from the specified project

Can be specified multiple times. Also accepts PREK_SKIP or SKIP environment variables (comma-delimited).

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek run¶

Run configured hooks

Usage

prek run [OPTIONS] [HOOK|PROJECT]...

Arguments

Include the specified hooks or projects.

Supports flexible selector syntax:

hook-id: Run all hooks with the specified ID across all projects
project-path/: Run all hooks from the specified project
project-path:hook-id: Run only the specified hook from the specified project

Can be specified multiple times to select multiple hooks/projects.

Options

--all-files, -a

Run hooks on all tracked files in the repository

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--directory, -d dir

Run hooks on tracked files under the specified directory.

Paths are resolved relative to the current working directory after applying --cd. This option can be repeated and combined with --files and --glob.

Do not run the hooks, but print the hooks that would have been run

--fail-fast

Stop running hooks after the first failure

--files files

Run hooks on the specified file paths.

Paths are resolved relative to the current working directory after applying --cd. They may be tracked or untracked. This option accepts multiple paths and can be combined with --glob and --directory.

--from-ref, --source, -s from-ref

The original ref in a <from_ref>...<to_ref> diff expression. Files changed in this diff will be run through the hooks

--glob pattern

Run hooks on tracked files matching the specified glob pattern.

Patterns are matched against paths relative to the current working directory after applying --cd. Quote patterns to prevent shell expansion. This option can be repeated and combined with --files and --directory.

--group group

Run hooks belonging to the specified group.

Can be specified multiple times; a hook may match any specified group. When combined with --require-group, both filters must match.

--help, -h

Display the concise help for this command

--last-commit

Run hooks against the last commit. Equivalent to --from-ref HEAD~1 --to-ref HEAD

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

--no-group group

Do not run hooks belonging to the specified group.

Can be specified multiple times. Exclusion wins over inclusion.

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

--show-diff-on-failure

Refresh all cached data

--require-group group

Run hooks belonging to every specified group.

Can be specified multiple times; a hook must match every specified group. When combined with --group, it must also match at least one --group. --no-group excludes matching hooks regardless of argument order.

For example, --require-group fast --group format --group lint-only selects hooks in fast and either format or lint-only.

When hooks fail, run git diff directly afterward

--skip hook|project

Skip the specified hooks or projects.

Supports flexible selector syntax:

hook-id: Skip all hooks with the specified ID across all projects
project-path/: Skip all hooks from the specified project
project-path:hook-id: Skip only the specified hook from the specified project

Can be specified multiple times. Also accepts PREK_SKIP or SKIP environment variables (comma-delimited).

--stage, --hook-stage stage

The stage during which the hook is fired.

When specified, only hooks configured for that stage (for example manual, pre-commit, or pre-push) will run. When not specified and no group filter is active, this command starts with hooks eligible for pre-commit. If no hook is selected and the command named hook IDs, those same IDs are matched again against hooks configured for manual. With --group, --require-group, or --no-group, omitting the stage lets hooks from any configured stage match, using the default file input mode; hooks that only run at commit-msg or prepare-commit-msg are ignored.

Possible values:

manual
commit-msg
post-checkout
post-commit
post-merge
post-rewrite
pre-commit
pre-merge-commit
pre-push
pre-rebase
prepare-commit-msg

--to-ref, --origin, -o to-ref

The destination ref in a from_ref...to_ref diff expression. Defaults to HEAD if from_ref is specified

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek exec¶

Run a command in the environment prepared for a configured hook

Usage

prek exec [OPTIONS] <HOOK> -- <COMMAND>...

Arguments

HOOK

Hook whose execution environment should be used.

Supports hook-id and project-path:hook-id selectors and must resolve to exactly one configured hook.

COMMAND

Command and arguments to execute

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--help, -h

Display the concise help for this command

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek list¶

List configured hooks

Usage

prek list [OPTIONS] [HOOK|PROJECT]...

Arguments

Include the specified hooks or projects.

Supports flexible selector syntax:

hook-id: Run all hooks with the specified ID across all projects
project-path/: Run all hooks from the specified project
project-path:hook-id: Run only the specified hook from the specified project

Can be specified multiple times to select multiple hooks/projects.

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--group group

Show hooks belonging to the specified group.

Can be specified multiple times.

--help, -h

Display the concise help for this command

--hook-stage hook-stage

Show only hooks that has the specified stage

Possible values:

manual
commit-msg
post-checkout
post-commit
post-merge
post-rewrite
pre-commit
pre-merge-commit
pre-push
pre-rebase
prepare-commit-msg

--language language

Show only hooks that are implemented in the specified language

Possible values:

bun
conda
coursier
dart
deno
docker
docker-image
dotnet
fail
golang
haskell
julia
lua
mise
node
perl
php
pygrep
python
r
ruby
rust
script
swift
system

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

--no-group group

Do not show hooks belonging to the specified group.

Can be specified multiple times. Exclusion wins over inclusion.

Hide all progress outputs.

For example, spinners or progress bars.

--output-format output-format

The output format

[default: text]

Possible values:

text
json

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--require-group group

Show hooks belonging to every specified group.

Can be specified multiple times. Composes with --group and --no-group.

--skip hook|project

Skip the specified hooks or projects.

Supports flexible selector syntax:

hook-id: Skip all hooks with the specified ID across all projects
project-path/: Skip all hooks from the specified project
project-path:hook-id: Skip only the specified hook from the specified project

Can be specified multiple times. Also accepts PREK_SKIP or SKIP environment variables (comma-delimited).

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek uninstall¶

Uninstall prek Git hook shims

Usage

prek uninstall [OPTIONS]

Options

--all

Uninstall all prek-managed Git shims.

Scans the hooks directory and removes every hook managed by prek, regardless of hook type.

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--git-dir git-dir

Uninstall Git shims from the hooks subdirectory of the given git directory (<GIT_DIR>/hooks/).

When this flag is used, prek uninstall bypasses the safety check that normally refuses to modify shims while core.hooksPath is configured outside the repo. It only removes shims from <GIT_DIR>/hooks; Git may still use the configured core.hooksPath until that config changes.

--help, -h

Display the concise help for this command

--hook-type, -t hook-type

Which Git shim(s) to uninstall.

Specifies which Git hook type(s) you want to uninstall shims for. Can be specified multiple times to uninstall shims for multiple hook types.

If not specified, uses default_install_hook_types from the config file, or defaults to pre-commit if that is also not set. Use --all to remove all prek-managed hooks.

Possible values:

commit-msg
post-checkout
post-commit
post-merge
post-rewrite
pre-commit
pre-merge-commit
pre-push
pre-rebase
prepare-commit-msg

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek validate-config¶

Validate prek configuration files

Usage

prek validate-config [OPTIONS] [CONFIG]...

Arguments

CONFIG: The path to the configuration file

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--help, -h

Display the concise help for this command

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek validate-manifest¶

Validate pre-commit hook manifests (.pre-commit-hooks.yaml)

Usage

prek validate-manifest [OPTIONS] [MANIFEST]...

Arguments

MANIFEST: The path to the manifest file

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--help, -h

Display the concise help for this command

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek sample-config¶

Generate a sample prek configuration file

Usage

prek sample-config [OPTIONS]

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--file, -f file

Write the sample config to a file.

Defaults to .pre-commit-config.yaml unless --format toml is set, which uses prek.toml. If a path is provided without --format, the format is inferred from the file extension (.toml uses TOML).

--format format

Select the sample configuration format

Possible values:

yaml
toml

--help, -h

Display the concise help for this command

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek update¶

Update configured repositories

Usage

prek update [OPTIONS]

Options

--bleeding-edge

Update to the bleeding edge of the default branch instead of the latest tagged version

--cd, -C dir

Change to directory before running

--check

Alias of --dry-run --exit-code

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--cooldown-days days

Minimum release age (in days) required for a version to be eligible.

The age is computed from the tag creation timestamp for annotated tags, or from the tagged commit timestamp for lightweight tags. If the current rev is newer than the latest cooldown-eligible tag, prek update keeps the current rev instead of downgrading it. Defaults to update.cooldown_days in the project or global config, or 0 when unset. Valid values are 0 through 255; 0 disables this check.

Do not write changes to the config file, only display what would be changed

--exclude-repo repo

Do not update this repository. This option may be specified multiple times

--exclude-tag pattern

Ignore tags matching this glob pattern. This option may be specified multiple times. Defaults to update.exclude_tags in the project or global config when unset.

For example, use --exclude-tag nightly to skip a moving tag, or --exclude-tag '*-{alpha,beta,rc}*' to skip common prerelease tags.

--exit-code

Exit with status 1 if updates are available

--freeze

Store "frozen" hashes in rev instead of tag names. Defaults to update.freeze in the project or global config, or false when unset

--help, -h

Display the concise help for this command

--include-tag pattern

Only consider tags matching this glob pattern. This option may be specified multiple times. Defaults to update.include_tags in the project or global config when unset.

For example, use --include-tag 'v*' to only consider version tags and ignore tags such as nightly.

--jobs, -j jobs

Number of threads to use

[default: 0]

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--repo repo

Only update this repository. This option may be specified multiple times

--repo-exclude-tag repo=pattern

Ignore tags matching this glob pattern for a repository (<repo>=<pattern>). This option may be specified multiple times. Adds to the effective update exclude filters for the named repository.

Repo-specific exclude filters are added to global --exclude-tag filters; matching either filter excludes the tag for that repository.

For example, use --repo-exclude-tag https://github.com/example/repo=nightly or --repo-exclude-tag https://github.com/example/repo=*-rc* to skip nightly or prerelease tags for one repository.

--repo-include-tag repo=pattern

Only consider tags matching this glob pattern for a repository (<repo>=<pattern>). This option may be specified multiple times. Overrides the effective include filters for the named repository.

When set for a repository, this overrides any global --include-tag filters for that repository.

For example, use --repo-include-tag https://github.com/example/repo=v* to only consider version tags for one repository.

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek cache¶

Manage the prek cache

Usage

prek cache [OPTIONS] <COMMAND>

Commands

prek cache dir: Show the location of the prek cache
prek cache gc: Remove unused cached repositories, hook environments, and other data
prek cache clean: Remove all prek cached data
prek cache size: Show the size of the prek cache

prek cache dir¶

Show the location of the prek cache

Usage

prek cache dir [OPTIONS]

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--help, -h

Display the concise help for this command

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek cache gc¶

Remove unused cached repositories, hook environments, and other data

Usage

prek cache gc [OPTIONS]

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

Print what would be removed, but do not delete anything

--help, -h

Display the concise help for this command

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek cache clean¶

Remove all prek cached data

Usage

prek cache clean [OPTIONS]

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--help, -h

Display the concise help for this command

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek cache size¶

Show the size of the prek cache

Usage

prek cache size [OPTIONS]

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--help, -h

Display the concise help for this command

--human, --human-readable, -H

Display the cache size in human-readable format (e.g., 1.2GiB instead of raw bytes)

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--output-format output-format

Select the output format

[default: auto]

Possible values:

auto: Display a human-readable size in terminals and raw bytes otherwise
human: Display the cache size in a human-readable format
machine: Display the cache size in raw bytes

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek try-repo¶

Try hooks from a repository

Usage

prek try-repo [OPTIONS] <REPO> [HOOK|PROJECT]...

Arguments

REPO

Repository to source hooks from

Include the specified hooks or projects.

Supports flexible selector syntax:

hook-id: Run all hooks with the specified ID across all projects
project-path/: Run all hooks from the specified project
project-path:hook-id: Run only the specified hook from the specified project

Can be specified multiple times to select multiple hooks/projects.

Options

--all-files, -a

Run hooks on all tracked files in the repository

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--directory, -d dir

Run hooks on tracked files under the specified directory.

Paths are resolved relative to the current working directory after applying --cd. This option can be repeated and combined with --files and --glob.

Do not run the hooks, but print the hooks that would have been run

--fail-fast

Stop running hooks after the first failure

--files files

Run hooks on the specified file paths.

Paths are resolved relative to the current working directory after applying --cd. They may be tracked or untracked. This option accepts multiple paths and can be combined with --glob and --directory.

--from-ref, --source, -s from-ref

The original ref in a <from_ref>...<to_ref> diff expression. Files changed in this diff will be run through the hooks

--glob pattern

Run hooks on tracked files matching the specified glob pattern.

Patterns are matched against paths relative to the current working directory after applying --cd. Quote patterns to prevent shell expansion. This option can be repeated and combined with --files and --directory.

--help, -h

Display the concise help for this command

--last-commit

Run hooks against the last commit. Equivalent to --from-ref HEAD~1 --to-ref HEAD

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

--show-diff-on-failure

Refresh all cached data

--rev, --ref rev

Manually select a rev to run against, otherwise the HEAD revision will be used

When hooks fail, run git diff directly afterward

--skip hook|project

Skip the specified hooks or projects.

Supports flexible selector syntax:

hook-id: Skip all hooks with the specified ID across all projects
project-path/: Skip all hooks from the specified project
project-path:hook-id: Skip only the specified hook from the specified project

Can be specified multiple times. Also accepts PREK_SKIP or SKIP environment variables (comma-delimited).

--stage, --hook-stage stage

The stage during which the hook is fired.

When specified, only hooks configured for that stage (for example manual, pre-commit, or pre-push) will run. When not specified, this command starts with hooks eligible for pre-commit. If no hook is selected and the command named hook IDs, those same IDs are matched again against hooks configured for manual.

Possible values:

manual
commit-msg
post-checkout
post-commit
post-merge
post-rewrite
pre-commit
pre-merge-commit
pre-push
pre-rebase
prepare-commit-msg

--to-ref, --origin, -o to-ref

The destination ref in a from_ref...to_ref diff expression. Defaults to HEAD if from_ref is specified

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek util¶

Run utility commands

Usage

prek util [OPTIONS] <COMMAND>

Commands

prek util identify: Show file identification tags
prek util list-builtins: List all built-in hooks bundled with prek
prek util init-template-dir: Install Git shims in a directory intended for use with git config init.templateDir
prek util yaml-to-toml: Convert a YAML configuration file to prek.toml

prek util identify¶

Show file identification tags

Usage

prek util identify [OPTIONS] [PATH]...

Arguments

PATH: The path(s) to the file(s) to identify

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--help, -h

Display the concise help for this command

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--output-format output-format

The output format

[default: text]

Possible values:

text
json

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek util list-builtins¶

List all built-in hooks bundled with prek

Usage

prek util list-builtins [OPTIONS]

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--help, -h

Display the concise help for this command

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--output-format output-format

The output format

[default: text]

Possible values:

text
json

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

--no-allow-missing-config

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek util init-template-dir¶

Install Git shims in a directory intended for use with git config init.templateDir

Usage

prek util init-template-dir [OPTIONS] <DIRECTORY>

Arguments

DIRECTORY: The directory in which to write the Git shim

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--help, -h

Display the concise help for this command

--hook-type, -t hook-type

Which Git shim(s) to install.

Specifies which Git hook type(s) you want to install shims for. Can be specified multiple times to install shims for multiple hook types.

If not specified, uses default_install_hook_types from the config file, or defaults to pre-commit if that is also not set.

Possible values:

commit-msg
post-checkout
post-commit
post-merge
post-rewrite
pre-commit
pre-merge-commit
pre-push
pre-rebase
prepare-commit-msg

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Assume cloned repos should have a pre-commit config

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek util yaml-to-toml¶

Convert a YAML configuration file to prek.toml

Usage

prek util yaml-to-toml [OPTIONS] [CONFIG]

Arguments

CONFIG: The YAML configuration file to convert. If omitted, discovers .pre-commit-config.yaml or .pre-commit-config.yml in the current directory

Options

--cd, -C dir

Change to directory before running

--color color

Whether to use color in output

May also be set with the PREK_COLOR environment variable.

[default: auto]

Possible values:

auto: Enables colored output only when the output is going to a terminal or TTY with support
always: Enables colored output regardless of the detected environment
never: Disables colored output

--config, -c config

Path to alternate config file

--force

Overwrite the output file if it already exists

--help, -h

Display the concise help for this command

--log-file log-file

Write trace logs to the specified file. If not specified, trace logs will be written to $PREK_HOME/prek.log

Hide all progress outputs.

For example, spinners or progress bars.

--output, -o output

Path to write the generated prek.toml file. Defaults to prek.toml in the same directory as the input file

--quiet, -q

Use quiet output.

Repeating this option, e.g., -qq, will enable a silent mode in which prek will write no output to stdout.

May also be set with the PREK_QUIET environment variable.