prek/docs/index.md

prek

--8<-- "README.md:description"

!!! note

Although prek is pretty new, it's already powering real‑world projects—see [Who is using prek?](#who-is-using-prek). If you're looking for an alternative to `pre-commit`, please give it a try—we'd love your feedback!

Please note that some subcommands and languages are still missing for full drop‑in parity with `pre-commit`. Track the remaining gaps here: [TODO](https://prek.j178.dev/todo/).

--8<-- "README.md:features"

--8<-- "README.md:why"

Badges

Show that your project uses prek with a badge in your README:

=== "Markdown"

```markdown
[![prek](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json)](https://github.com/j178/prek)
```

=== "HTML"

```html
<a href="https://github.com/j178/prek">
  <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json" alt="prek">
</a>
```

=== "reStructuredText (RST)"

```rst
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json
   :target: https://github.com/j178/prek
   :alt: prek
```