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 pre-commit 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

--help, -h

Display the concise help for this command

--hook-type, -t hook-type

--install-hooks

Create hook environments for all hooks used in the config file

Hide all progress outputs.

For example, spinners or progress bars.

--overwrite, -f

Overwrite existing hooks

--quiet, -q

Do not print any output

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 install-hooks¶

Create hook environments for all hooks used in the config file.

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

Usage

prek install-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

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Do not print any output

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 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 on all files in the repo

--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 all files in the specified directories.

You can specify multiple directories. It can be used in conjunction with --files.

--dry-run

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

--files files

Specific filenames to run hooks on

--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

--help, -h

Display the concise help for this command

--hook-stage hook-stage

The stage during which the hook is fired

[default: pre-commit]

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

--last-commit

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

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Do not print any output

--show-diff-on-failure

Refresh all cached data

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).

--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 list¶

List available 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

--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:

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

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

Do not print any output

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 uninstall¶

Uninstall the prek git hook

Usage

prek uninstall [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

--hook-type, -t hook-type

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Do not print any output

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek validate-config¶

Validate .pre-commit-config.yaml 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

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Do not print any output

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek validate-manifest¶

Validate .pre-commit-hooks.yaml files

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

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Do not print any output

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek sample-config¶

Produce a sample .pre-commit-config.yaml 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 (.pre-commit-config.yaml by default)

--help, -h

Display the concise help for this command

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Do not print any output

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek auto-update¶

Auto-update pre-commit config to the latest repos' versions

Usage

prek auto-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

--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

--freeze

Store "frozen" hashes in rev instead of tag names

--help, -h

Display the concise help for this command

--jobs, -j jobs

Number of threads to use

[default: 3]

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Do not print any output

Refresh all cached data

--repo repo

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

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek gc¶

Clean unused cached repos

Usage

prek 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

--help, -h

Display the concise help for this command

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Do not print any output

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek clean¶

Clean out pre-commit files

Usage

prek 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

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Do not print any output

--no-allow-missing-config

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek init-template-dir¶

Install hook script in a directory intended for use with git config init.templateDir

Usage

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

Arguments

DIRECTORY: The directory in which to write the hook script

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 hook type to install

Possible values:

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

Assume cloned repos should have a pre-commit config

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Do not print any output

Refresh all cached data

--verbose, -v

Use verbose output

--version, -V

Display the prek version

prek try-repo¶

Try the pre-commit hooks in the current repo

Usage

prek try-repo [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 on all files in the repo

--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 all files in the specified directories.

You can specify multiple directories. It can be used in conjunction with --files.

--dry-run

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

--files files

Specific filenames to run hooks on

--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

--help, -h

Display the concise help for this command

--hook-stage hook-stage

The stage during which the hook is fired

[default: pre-commit]

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

--last-commit

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

Hide all progress outputs.

For example, spinners or progress bars.

--quiet, -q

Do not print any output