Installation¶

$ uv tool install konform     # isolated, on your PATH
$ uvx konform check src/      # or run it without installing

$ pipx install konform

$ pip install konform

Wheels ship a pre-compiled Rust binary, so no Rust installation is needed at runtime.

Verify the install:

$ konform version

Verifying release artifacts¶

Every wheel, sdist and standalone binary attached to a GitHub release carries a signed build provenance attestation, proving it was built by konform's release workflow from the tagged commit. Check a downloaded file with the GitHub CLI:

$ gh attestation verify konform-x86_64-unknown-linux-gnu --repo benediktziegler/konform

Add --signer-workflow benediktziegler/konform/.github/workflows/release.yml to also pin the workflow that produced it. Packages on PyPI additionally carry PyPI's own publish attestations.

Initialising a project¶

konform init adds a [tool.konform] section to an existing pyproject.toml (after any Ruff blocks) (or creates konform.toml if there is none) and adds a konform_patterns.toml:

$ konform init

Shell completions¶

konform completions <shell> prints a completion script for bash, zsh, fish, elvish or powershell:

$ konform completions zsh > ~/.zfunc/_konform                      # zsh (~/.zfunc must be in $fpath)
$ konform completions bash > ~/.local/share/bash-completion/completions/konform
$ konform completions fish > ~/.config/fish/completions/konform.fish

pre-commit¶

Add konform to your .pre-commit-config.yaml:

repos:
  - repo: https://github.com/benediktziegler/konform
    rev: v0.4.0  # pin a release tag
    hooks:
      - id: konform        # lint only
      # - id: konform-fix  # lint and apply safe fixes; fails the commit when it changed files

pre-commit builds konform from source with cargo (installing a Rust toolchain if needed), so the first run takes a minute; later runs use the cached build.