prek

https://prek.j178.dev
Admin
prek is a faster, dependency-free Rust-based reimagining of pre-commit that manages git hooks with...
Tokens:34,136
Snippets:537
Trust Score:5.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install via Winget

Source: https://prek.j178.dev/installation

Installs prek on Windows using Winget.

```bash
winget install --id j178.Prek
```

--------------------------------

### Install via Scoop

Source: https://prek.j178.dev/installation

Installs prek on Windows using Scoop.

```bash
scoop install main/prek
```

--------------------------------

### Examples of hook and project selection

Source: https://prek.j178.dev/workspace

Practical examples of selecting specific hooks and projects for execution.

```bash
# Run all 'black' hooks across all projects
prek run black

# Run all hooks from the 'frontend' project
prek run frontend/

# Run only the 'lint' hook from the 'frontend' project
prek run frontend:lint

# Run the 'lint' from 'frontend' and 'black' from 'src/backend'
prek run frontend:lint src/backend:black
```

--------------------------------

### Install via Standalone Script

Source: https://prek.j178.dev/installation

Downloads and executes the installation script for macOS/Linux or Windows.

```bash
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/j178/prek/releases/download/v0.5.2/prek-installer.sh | sh
```

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://github.com/j178/prek/releases/download/v0.5.2/prek-installer.ps1 | iex"
```

--------------------------------

### Prepare hook environments during installation

Source: https://prek.j178.dev/usage

Pre-installs hook environments during the setup process rather than on first use.

```bash
prek install --prepare-hooks
```

--------------------------------

### Install via Homebrew

Source: https://prek.j178.dev/installation

Installs prek on macOS or Linux using Homebrew.

```bash
brew install prek
```

--------------------------------

### Install via cargo-binstall

Source: https://prek.j178.dev/installation

Installs pre-compiled binaries from GitHub using cargo-binstall.

```bash
cargo binstall prek
```

--------------------------------

### prek install usage syntax

Source: https://prek.j178.dev/reference/cli

The basic command structure for installing Git hook shims.

```bash
prek install [OPTIONS] [HOOK|PROJECT]...
```

--------------------------------

### Install via PyPI

Source: https://prek.j178.dev/installation

Installs prek using Python package managers.

```bash
# Using uv (recommended)
uv tool install prek

# Using uvx (install and run in one command)
uvx prek

# Adding prek to the project dev-dependencies
uv add --dev prek

# Using pip
pip install prek

# Using pipx
pipx install prek
```

--------------------------------

### Install via Nix

Source: https://prek.j178.dev/installation

Installs prek using the Nix package manager.

```bash
# Choose what's appropriate for your use case.
# One-off in a shell:
nix-shell -p prek

# NixOS or non-NixOS without flakes:
nix-env -iA nixos.prek

# Non-NixOS with flakes:
nix profile install nixpkgs#prek
```

--------------------------------

### Initialize a repository with prek

Source: https://prek.j178.dev/quickstart

Create a starter configuration file and install the Git shim.

```bash
prek init
```

--------------------------------

### Verify Installation

Source: https://prek.j178.dev/installation

Checks the installed version of prek.

```bash
prek --version
```

```bash
uv run prek --version
```

```bash
uvx prek --version
```

```bash
npm exec -- prek --version
```

--------------------------------

### Build from Source

Source: https://prek.j178.dev/installation

Builds and installs prek from source using Cargo.

```bash
cargo install --locked prek
```

--------------------------------

### Install via mise

Source: https://prek.j178.dev/installation

Installs prek using the mise tool manager.

```bash
mise use prek
```

--------------------------------

### Initialize template directory

Source: https://prek.j178.dev/reference/cli

Usage pattern for installing Git shims in a specified directory.

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

--------------------------------

### Example YAML file

Source: https://prek.j178.dev/quickstart

A sample YAML file to test the hook execution.

```yaml
project: prek
enabled: true
```

--------------------------------

### Install via MacPorts

Source: https://prek.j178.dev/installation

Installs prek on macOS using MacPorts.

```bash
sudo port install prek
```

--------------------------------

### Examples of skipping projects or hooks

Source: https://prek.j178.dev/workspace

Practical examples demonstrating how to exclude specific projects or hooks from the execution flow.

```bash
# Run all hooks except those from the 'frontend' project
prek run --skip frontend/

# Run hooks from 'frontend' but skip 'frontend/docs'
prek run frontend/ --skip frontend/docs

# Run hooks from 'frontend' but skip 'frontend/docs' and 'frontend:lint'
prek run frontend/ --skip frontend/docs --skip frontend:lint

# Run all hooks except 'black' and 'markdownlint' hooks
prek run --skip black --skip markdownlint
```

--------------------------------

### Install via npm

Source: https://prek.j178.dev/installation

Installs prek as a global or project-specific Node.js package.

```bash
# npm
npm install -g @j178/prek

# pnpm
pnpm add -g @j178/prek

# bun
bun install -g @j178/prek
```

```bash
npm add -D @j178/prek
```

--------------------------------

### Install prek in a repository

Source: https://prek.j178.dev/usage

Installs Git shims based on the existing configuration file in the repository root.

```bash
prek install
```

--------------------------------

### Install via Conda

Source: https://prek.j178.dev/installation

Installs prek from the conda-forge channel.

```bash
conda install conda-forge::prek
```

--------------------------------

### Global update configuration example

Source: https://prek.j178.dev/reference/configuration

Example TOML configuration for the update section, defining cooldown days, freeze status, and tag inclusion/exclusion patterns.

```toml
[update]
cooldown_days = 7
freeze = true
include_tags = "v*"
exclude_tags = ["*-{alpha,beta,rc}*"]
```

--------------------------------

### Install prek skill for agents

Source: https://prek.j178.dev/integrations

Install the prek skill using the GitHub CLI to enable agent-based interactions.

```bash
gh skill install j178/prek prek
```

--------------------------------

### Verify Git hook installation

Source: https://prek.j178.dev/debugging

Confirm that the Git shim is correctly installed and configured for prek.

```bash
prek install
git config --show-origin --get core.hooksPath
```

--------------------------------

### prek init

Source: https://prek.j178.dev/reference/cli

Creates a prek configuration and installs Git hook shims in the specified directory.

```APIDOC
## prek init

### Description
Create a prek configuration and install Git hook shims.

### Usage
`prek init [OPTIONS] [PATH]`

### Arguments
- **PATH** (string) - Optional - Existing directory to initialize. Defaults to the current Git worktree root.

### Options
- **--cd, -C** (dir) - Optional - Change to directory before running.
- **--color** (string) - Optional - Whether to use color in output (auto, always, never).
- **--config, -c** (string) - Optional - Path to alternate config file.
- **--format** (string) - Optional - Select the configuration format to create (yaml, toml).
- **--no-install** (boolean) - Optional - Do not install Git hook shims.
- **--quiet, -q** (boolean) - Optional - Use quiet output.
```

--------------------------------

### Update prek installation

Source: https://prek.j178.dev/reference/cli

Displays the usage syntax for updating the prek tool.

```bash
prek self update [OPTIONS] [TARGET_VERSION]
```

--------------------------------

### Initialize prek Configuration

Source: https://prek.j178.dev/reference/cli

The command syntax for initializing a new prek configuration and installing Git hook shims.

```bash
prek init [OPTIONS] [PATH]
```

--------------------------------

### Configure Builtin Hooks

Source: https://prek.j178.dev/builtin

Examples of defining builtin hooks in configuration files.

```yaml
[[repos]]
repo = "builtin"
hooks = [
  { id = "trailing-whitespace" },
  { id = "check-added-large-files" },
]
```

```yaml
repos:
  - repo: builtin
    hooks:
      - id: trailing-whitespace
      - id: check-added-large-files
```

--------------------------------

### Check prek environment and versions

Source: https://prek.j178.dev/debugging

Use these commands to verify the installed versions and current state of the prek environment.

```bash
prek --version
git --version
prek list
prek run --dry-run
```

--------------------------------

### Minimal Hook Repository Structure

Source: https://prek.j178.dev/authoring-hooks

Example directory layout for a Python-based hook repository.

```text
my-hook/
├── .pre-commit-hooks.yaml
├── pyproject.toml
└── src/
    └── my_hook/
        └── __init__.py
```

--------------------------------

### Force install prek hooks

Source: https://prek.j178.dev/usage

Replaces existing legacy hooks with prek shims.

```bash
prek install -f
```

--------------------------------

### Define hook arguments

Source: https://prek.j178.dev/reference/configuration

Example of passing extra arguments to a hook's entry command.

```toml
hooks = [{ id = "ruff", args = ["--fix"] }]
```

```yaml
hooks:
  - id: ruff
    args: [--fix]
```

--------------------------------

### prek util list-builtins

Source: https://prek.j178.dev/builtin

Lists all built-in hooks bundled with the installed version of prek.

```APIDOC
## CLI Command

### Description
Lists the builtins bundled with your installed prek version.

### Command
`prek util list-builtins`
```

--------------------------------

### Define a global hook configuration file

Source: https://prek.j178.dev/cookbook

Example TOML configuration for a global hook, such as running gitleaks.

```toml
[[repos]]
repo = "https://github.com/gitleaks/gitleaks"
rev = "v8.24.2"
hooks = [{ id = "gitleaks" }]
```

--------------------------------

### Configure Builtin Hooks with Arguments

Source: https://prek.j178.dev/builtin

Example of passing arguments to builtin hooks using the args key.

```yaml
repos:
  - repo: builtin
    hooks:
      - id: trailing-whitespace
        args: [--markdown-linebreak-ext=md]
      - id: check-added-large-files
        args: [--maxkb=1024]
```

--------------------------------

### Example prek run output

Source: https://prek.j178.dev/workspace

Displays the console output when executing the prek run command, showing the hierarchical processing of hooks across different directories.

```text
$ prek run
✓ src/backend
  check python ast.......................................................Passed
  check for merge conflicts..............................................Passed
  black..................................................................Passed
  isort..................................................................Passed
✓ docs
  Markdownlint..........................................................Passed
✓ frontend
  prettier...............................................................Passed
✓ src
  isort..................................................................Passed
  mypy...................................................................Passed
  check python ast.......................................................Passed
  check docstring is first...............................................Passed
✓ <workspace>
  fix end of files.......................................................Passed
  check yaml.............................................................Passed
  check for added large files............................................Passed
  trim trailing whitespace...............................................Passed
  check for merge conflicts..............................................Passed
```

--------------------------------

### Configure a local hook with shell execution

Source: https://prek.j178.dev/reference/configuration

Example of a local hook using the bash shell adapter to run multiple commands.

```toml
[[repos]]
repo = "local"
hooks = [
  {
    id = "test-all",
    name = "test-all",
    language = "system",
    entry = """
    uv run --python=3.10 --isolated pytest
    uv run --python=3.11 --isolated pytest
    """,
    shell = "bash",
    pass_filenames = false,
  },
]
```

```yaml
repos:
  - repo: local
    hooks:
      - id: test-all
        name: test-all
        language: system
        entry: |
          uv run --python=3.10 --isolated pytest
          uv run --python=3.11 --isolated pytest
        shell: bash
        pass_filenames: false
```

--------------------------------

### Manage legacy hooks during migration

Source: https://prek.j178.dev/migration

Commands to install prek in migration mode or finalize the migration by replacing legacy hooks.

```bash
prek install
```

```bash
prek install --force
```

--------------------------------

### Configure deny-filename-pattern hook

Source: https://prek.j178.dev/builtin

Example configuration for the deny-filename-pattern hook to disallow spaces in filenames.

```yaml
repos:
  - repo: builtin
    hooks:
      - id: deny-filename-pattern
        name: disallow spaces in filenames
        args: ['\s']
```

--------------------------------

### Add Ruff hooks to configuration

Source: https://prek.j178.dev/quickstart

Example of adding external hooks to the prek.toml configuration file.

```toml
[[repos]]
repo = "https://github.com/astral-sh/ruff-pre-commit"
rev = "v0.16.0"
hooks = [
  { id = "ruff-check" },
  { id = "ruff-format" },
]
```

--------------------------------

### Configure hook with executable additional dependency

Source: https://prek.j178.dev/languages

Install and use an executable dependency by specifying it in additional_dependencies and referencing it in the entry.

```yaml
repos:
  - repo: local
    hooks:
      - id: semver-version
        name: semver version
        language: deno
        entry: semver-tool 1.2.3
        additional_dependencies:
          - npm:semver@7:semver-tool
        pass_filenames: false
```

--------------------------------

### Configure deny-pattern hook

Source: https://prek.j178.dev/builtin

Example configuration for the deny-pattern hook to disallow wildcard imports in .typ files.

```yaml
repos:
  - repo: builtin
    hooks:
      - id: deny-pattern
        name: disallow wildcard imports
        args: ['^\s*#import\s+.+:\s*\*']
        files: \.typ$
```

--------------------------------

### Define Hook Entries

Source: https://prek.j178.dev/authoring-hooks

Examples of hook definitions using different languages and file matching patterns.

```yaml
- id: format-json
  name: format json
  entry: python3 -m tools.format_json
  language: python
  files: "\\.json$"

- id: lint-shell
  name: shellcheck
  entry: shellcheck
  language: system
  types: [shell]

```

--------------------------------

### Configure local hooks in TOML

Source: https://prek.j178.dev/configuration

Examples of defining local hooks using multiline inline tables versus the longer array-of-tables format.

```toml
default_language_version.python = "3.12"

[[repos]]
repo = "local"
hooks = [
  {
    id = "ruff",
    name = "ruff",
    language = "system",
    entry = "python3 -m ruff check",
    files = "\\.py$",
  },
]
```

```toml
default_language_version.python = "3.12"

[[repos]]
repo = "local"

[[repos.hooks]]
id = "ruff"
name = "ruff"
language = "system"
entry = "python3 -m ruff check"
files = "\\.py$"
```

--------------------------------

### Configure .NET additional dependencies

Source: https://prek.j178.dev/languages

Specify tools to install in the hook's isolated tools directory using package names and optional version pinning.

```yaml
repos:
  - repo: https://github.com/example/csharpier-hook
    rev: v1.0.0
    hooks:
      - id: csharpier
        additional_dependencies:
          # Pin to a specific version
          - "csharpier:1.2.6"
          # Or install the latest version available
          - "dotnet-format"
```

--------------------------------

### Configure Hook Language Versions

Source: https://prek.j178.dev/reference/configuration

Examples of defining language versions using both string and map formats in TOML and YAML configurations.

```toml
hooks = [
  { id = "ruff", language = "python", language_version = "3.12" },
  { id = "eslint", language = "node", language_version = { request = "20", preference = "only-managed" } },
  { id = "cargo-fmt", language = "rust", language_version = "stable" },
  { id = "my-tool", language = "system", language_version = "system" },
]
```

```yaml
hooks:
  - id: ruff
    language: python
    language_version: "3.12"

  - id: eslint
    language: node
    language_version:
      request: "20"
      preference: only-managed

  - id: cargo-fmt
    language: rust
    language_version: stable

  - id: my-tool
    language: system
    language_version: system
```

--------------------------------

### Run the benchmark suite

Source: https://prek.j178.dev/benchmark

Commands to clone the benchmark repository, set up the required tools, and execute the benchmark scripts.

```bash
git clone https://github.com/prek-ci/benchmarks.git
cd benchmarks
./scripts/setup-tools.sh
./benchmark.sh
```

--------------------------------

### Define project configuration in TOML

Source: https://prek.j178.dev/configuration

Recommended format for new users using prek.toml.

```toml
[[repos]]
repo = "https://github.com/pre-commit/pre-commit-hooks"
rev = "v6.0.0"
hooks = [
  { id = "trailing-whitespace" },
  { id = "check-toml" },
]

[[repos]]
repo = "local"
hooks = [
  {
    id = "cargo-fmt",
    name = "cargo fmt",
    language = "system",
    entry = "cargo fmt --",
    types = ["rust"],
    pass_filenames = false,
  },
]
```

--------------------------------

### Update prek

Source: https://prek.j178.dev/installation

Updates the standalone installation to the latest version.

```bash
prek self update
```

--------------------------------

### prek try-repo command usage

Source: https://prek.j178.dev/reference/cli

Basic syntax for executing hooks from a repository.

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

--------------------------------

### Run Prek in Single Config Mode

Source: https://prek.j178.dev/workspace

Use the --config or -c flag to specify a single configuration file for execution.

```bash
# Disable workspace mode, use specific config
prek run --config .pre-commit-config.yaml

# Use config from a subdirectory
prek run --config src/.pre-commit-config.yaml

# Short form using -c
prek run -c docs/.pre-commit-config.yaml
```

--------------------------------

### Stage files for prek

Source: https://prek.j178.dev/quickstart

Add the configuration and test files to the Git staging area.

```bash
git add prek.toml example.yaml
```

--------------------------------

### Configure file patterns using glob lists

Source: https://prek.j178.dev/changelog

Modern configuration format using glob lists for improved readability and maintenance.

```yaml
files:
  glob:
    - src/**/*.rs
    - crates/**/src/**/*.rs
```

--------------------------------

### Configure file-contents-sorter hook

Source: https://prek.j178.dev/builtin

Example configuration for the file-contents-sorter hook in a pre-commit configuration file.

```yaml
repos:
  - repo: builtin
    hooks:
      - id: file-contents-sorter
        files: ^requirements(-dev)?\.txt$
```

--------------------------------

### Select hooks and projects

Source: https://prek.j178.dev/workspace

Syntax patterns for targeting specific hooks or projects using the prek run command.

```bash
# Run all hooks with a specific ID across all projects
prek run <hook-id>

# Run only hooks from a specific project
prek run <project-path>/

# Run only hooks with a specific ID from a specific project
prek run <project-path>:<hook-id>
```

--------------------------------

### General CLI Usage

Source: https://prek.j178.dev/reference/cli

The basic syntax for invoking the prek command-line tool.

```bash
prek [OPTIONS] [HOOK|PROJECT]... [COMMAND]
```

--------------------------------

### Handling a hook failure

Source: https://prek.j178.dev/usage

Example output when a hook rejects a commit due to a validation error.

```bash
$ git commit -m "Update settings"
check json...............................................................Failed
- hook id: check-json
- exit code: 1

  settings.json: Failed to json decode (trailing comma at line 3 column 1)
```

--------------------------------

### Run prek util commands

Source: https://prek.j178.dev/reference/cli

General usage pattern for executing utility commands.

```bash
prek util [OPTIONS] <COMMAND>
```

--------------------------------

### Run prek Docker images

Source: https://prek.j178.dev/integrations

Execute the prek binary directly from the scratch or Alpine-based container images.

```bash
docker run --rm ghcr.io/j178/prek:0.5.2 --version
```

```bash
docker run --rm ghcr.io/j178/prek:0.5.2-alpine --version
```

--------------------------------

### Define Dart package executables

Source: https://prek.j178.dev/languages

Example of a pubspec.yaml file declaring custom executables for Dart hooks.

```yaml
name: my_dart_hooks

executables:
  my-hook:
  aliased-hook: tool/main
```

--------------------------------

### Configure a local test hook for pre-push

Source: https://prek.j178.dev/migration

Demonstrates setting up a system-level hook for cargo tests restricted to the pre-push stage.

```toml
default_install_hook_types = ["pre-commit", "pre-push"]

[[repos]]
repo = "local"

[[repos.hooks]]
id = "tests"
name = "tests"
language = "system"
entry = "cargo test"
pass_filenames = false
stages = ["pre-push"]
```

--------------------------------

### List configured hooks

Source: https://prek.j178.dev/reference/cli

Basic usage syntax for listing hooks or projects with optional filters.

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

--------------------------------

### Execute prek prepare-hooks command

Source: https://prek.j178.dev/reference/cli

Standard usage pattern for the prepare-hooks command with optional arguments.

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

--------------------------------

### Default prek configuration

Source: https://prek.j178.dev/quickstart

The starter configuration generated by prek using built-in hooks.

```toml
[[repos]]
repo = "builtin"
hooks = [
  { id = "trailing-whitespace" },
  { id = "end-of-file-fixer" },
  { id = "check-added-large-files" },
]
```

--------------------------------

### Verify Git version

Source: https://prek.j178.dev/cookbook

Check if the installed Git version supports config-based hooks (requires 2.54 or newer).

```bash
git --version
```

--------------------------------

### Exclude nested projects in configuration

Source: https://prek.j178.dev/configuration

Examples of excluding subdirectories from project discovery using glob patterns in TOML and YAML.

```toml
# foo/prek.toml
exclude = { glob = "bar/**" }
```

```yaml
# foo/.pre-commit-config.yaml
exclude:
  glob: "bar/**"
```

--------------------------------

### Configure file patterns using regex

Source: https://prek.j178.dev/changelog

Legacy configuration format using regular expressions for file filtering.

```yaml
files: "^(src/.*\\.rs$|crates/[^/]+/src/.*\\.rs$)"
```

--------------------------------

### Stage and run configuration changes

Source: https://prek.j178.dev/debugging

Ensure new or modified configuration files are staged before running prek to maintain snapshot consistency.

```bash
git add prek.toml
prek run
```

--------------------------------

### Configure Orphan Project Isolation

Source: https://prek.j178.dev/workspace

Example configuration for a subproject that prevents parent projects from processing its files by setting orphan to true.

```yaml
# src/backend/.pre-commit-config.yaml
orphan: true

repos:
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.8.4
    hooks:
      - id: ruff
```

--------------------------------

### Configure local Ruff hook with managed toolchain

Source: https://prek.j178.dev/changelog

Example of specifying a managed Python 3.12 toolchain for a local hook using the preference field.

```yaml
repos:
  - repo: local
    hooks:
      - id: ruff
        name: ruff
        language: python
        entry: ruff check
        additional_dependencies: [ruff]
        language_version:
          request: "3.12"
          preference: only-managed
```

--------------------------------

### Define project configuration in YAML

Source: https://prek.j178.dev/configuration

Alternative format for users already using pre-commit or requiring specific tool support.

```yaml
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v6.0.0
    hooks:
      - id: trailing-whitespace
      - id: check-toml

  - repo: local
    hooks:
      - id: cargo-fmt
        name: cargo fmt
        language: system
        entry: cargo fmt --
        types: [rust]
        pass_filenames: false
```

--------------------------------

### Run prek in CI

Source: https://prek.j178.dev/ci

Execute prek on all tracked files in a CI environment.

```bash
prek run --all-files
```

--------------------------------

### Run hooks with prek

Source: https://prek.j178.dev/quickstart

Execute configured hooks using the prek command line interface.

```bash
$ prek run
trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
typos....................................................................Passed
cargo fmt................................................................Passed
cargo clippy.............................................................Passed
```

--------------------------------

### Configure a local Python hook with PEP 723 metadata

Source: https://prek.j178.dev/languages

Defines a local Python hook in the configuration file and provides an example script using inline metadata for dependencies.

```yaml
repos:
  - repo: local
    hooks:
      - id: echo
        name: echo
        language: python
        entry: ./echo.py
```

```python
# /// script
# requires-python = ">=3.13"
# dependencies = [
#     "pyecho-cli",
# ]
# ///

from pyecho import main
main()
```

--------------------------------

### Configure ESLint hook with npm package

Source: https://prek.j178.dev/languages

Use the npm: prefix in the entry field to run npm packages via Deno.

```yaml
repos:
  - repo: local
    hooks:
      - id: eslint
        name: ESLint
        language: deno
        entry: deno run -A npm:eslint
        types: [ts, tsx, js, jsx]
```

--------------------------------

### Configure Prek with YAML and TOML

Source: https://prek.j178.dev/changelog

Compare the legacy YAML configuration format with the new TOML format supported in version 0.3.2.

```yaml
repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v6.0.0
    hooks:
      - id: check-yaml
```

```toml
[[repos]]
repo = "https://github.com/pre-commit/pre-commit-hooks"
rev = "v6.0.0"
hooks = [ { id = "check-yaml" } ]
```

--------------------------------

### Configure builtin repository hooks

Source: https://prek.j178.dev/reference/configuration

Uses prek's built-in fast hooks for common tasks.

```toml
[[repos]]
repo = "builtin"
hooks = [
  { id = "trailing-whitespace" },
  { id = "check-yaml" },
]
```

```yaml
repos:
  - repo: builtin
    hooks:
      - id: trailing-whitespace
      - id: check-yaml
```

--------------------------------

### Validate configuration files

Source: https://prek.j178.dev/reference/cli

Command syntax for validating prek configuration files.

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

--------------------------------

### Copy prek binary into a Docker image

Source: https://prek.j178.dev/integrations

Use this pattern to include the prek binary in a custom image based on a distribution like Debian.

```dockerfile
FROM debian:bookworm-slim
COPY --from=ghcr.io/j178/prek:0.5.2 /prek /usr/local/bin/prek
```

--------------------------------

### Run prek commands in a workspace

Source: https://prek.j178.dev/workspace

Basic commands for executing hooks from the current directory or specific project paths.

```bash
# Run from current directory, auto-discover workspace
prek run

# Run specific hook across all projects
prek run black

# Run from specific directory
cd src/backend && prek run

# Use -C option to change directory automatically
prek run -C src/backend
```

--------------------------------

### General prek cache usage

Source: https://prek.j178.dev/reference/cli

Displays the base command structure for cache management.

```bash
prek cache [OPTIONS] <COMMAND>
```

--------------------------------

### Update and prepare hooks

Source: https://prek.j178.dev/usage

Commands to update revisions and prepare environments without modifying Git shims.

```bash
prek update
prek prepare-hooks
```

--------------------------------

### Inspect and debug prek

Source: https://prek.j178.dev/usage

Commands for listing hooks and running with verbose output for troubleshooting.

```bash
prek list
```

```bash
prek run -vvv
```

--------------------------------

### Validate and inspect configuration

Source: https://prek.j178.dev/usage

Commands to verify configuration files and identify file type tags.

```bash
prek validate-config prek.toml
```

```bash
prek util identify path/to/file
```
Tokens:
Raw