Differences from pre-commit¶
General differences¶
preksupports both.pre-commit-config.yamland.pre-commit-config.ymlconfiguration files.prekimplements some common hooks frompre-commit-hooksin Rust for better performance.preksupportsrepo: builtinfor offline, zero-setup hooks.prekuses~/.cache/prekas the default cache directory for repos, environments and toolchains.prekdecoupled hook environment from their repositories, allowing shared toolchains and environments across hooks.preksupportslanguage_versionas a semver specifier and automatically installs the required toolchains.preksupportsfilesandexcludeas glob lists (in addition to regex) viaglobmappings. See Configuration.
Workspace mode¶
prek supports workspace mode, allowing you to run hooks for multiple projects in a single command. Each subproject can have its own .pre-commit-config.yaml file.
See Workspace Mode for more information.
Language support¶
See the dedicated Language Support page for a complete list of supported languages, prek-specific behavior, and unsupported languages.
Command line interface¶
prek run¶
prek run [HOOK|PROJECT]...supports selecting or skipping multiple projects or hooks in workspace mode. See Running Specific Hooks or Projects for details.prek runcan execute hooks in parallel by priority (hooks with the sameprioritymay run concurrently), instead of strictly serial execution.prekprovides dynamic completions of hook id.prek run --last-committo run hooks on files changed by the last commit.prek run --directory <DIR>to run hooks on a specified directory.
prek list¶
prek list command lists all available hooks, their ids, and descriptions. This provides a better overview of the configured hooks.
prek auto-update¶
prek auto-updateupdates all projects in the workspace to their latest revisions.prek auto-updatechecks updates for the same repository only once, speeding up the process in workspace mode.prek auto-updatesupports--dry-runoption to preview the updates without applying them.prek auto-updatesupports the--cooldown-daysoption to skip releases newer than the specified number of days (based on the tag creation timestamp for annotated tags, or the tagged commit timestamp for lightweight tags).
prek sample-config¶
prek sample-configcommand has a--fileoption to write the sample configuration to a specific file.
prek cache¶
prek cache cleanto remove all cached data.prek cache gcto remove unused cached repositories, environments and toolchains.prek cache dirto show the cache directory.
prek clean and prek gc are also available but hidden, as prek cache is preferred.