Change: Update documentation

n-thumann · greenbonebot · commit 37739c45064d · 2026-02-25T08:58:09.000+01:00
diff --git a/README.md b/README.md
@@ -96,6 +96,7 @@ autohooks:
 * `pythonpath` for dependency management via [pip]
 * `poetry` for dependency management via [poetry] (recommended)
 * `pipenv` for dependency management via [pipenv]
+* `uv` for dependency management via [uv]
 
 These modes handle how autohooks, the plugins and their dependencies are loaded
 during git hook execution.
@@ -165,3 +166,4 @@ Licensed under the [GNU General Public License v3.0 or later](LICENSE).
 [poetry]: https://python-poetry.org/
 [pylint]: https://pylint.readthedocs.io/en/latest/
 [ruff]: https://docs.astral.sh/ruff/
+[uv]: https://docs.astral.sh/uv/
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -11,7 +11,7 @@ and to set python modules to be run as [autohooks plugins](./plugins).
 ## Mode Configuration
 
 The mode can be set by adding a `mode =` line to the *pyproject.toml* file.
-Current possible options are `"pythonpath"`, `"pipenv"` and `"poetry"` (see
+Current possible options are `"pythonpath"`, `"pipenv"`, `"poetry"` and `"uv"`(see
 [autohooks mode](./modes)). If the mode setting is missing, the `pythonpath`
 mode is used.
 
@@ -40,6 +40,13 @@ mode = "pythonpath"
 ```
 ````
 
+````{group-tab} uv
+```toml
+[tool.autohooks]
+mode = "uv"
+```
+````
+
 `````
 
 Calling `autohooks activate` also allows for overriding the [mode](./modes)
@@ -66,6 +73,12 @@ autohooks activate --mode pythonpath --force
 ```
 ````
 
+````{group-tab} uv
+```bash
+autohooks activate --mode uv --force
+```
+````
+
 `````
 
 Please keep in mind that autohooks will always issue a warning if the mode used
@@ -110,4 +123,10 @@ autohooks plugins add autohooks.plugins.pylint
 ```
 ````
 
+````{group-tab} uv
+```bash
+uv run autohooks plugins add autohooks.plugins.pylint
+```
+````
+
 `````
diff --git a/docs/installation.md b/docs/installation.md
@@ -11,6 +11,7 @@ For fulfilling these steps different tooling can be used. Most prominent and cur
 * [poetry]
 * [pipenv]
 * [pip]
+* [uv]
 
 ```{note}
 Using [poetry] is recommended for installing and maintaining autohooks.
@@ -56,6 +57,14 @@ To install autohooks globally for the current user run
 python3 -m pip install --user autohooks
 ```
 `````
+
+`````{group-tab} uv
+To install autohooks as a development dependency run
+
+```{code-block}
+uv add --dev autohooks
+```
+`````
 ``````
 
 ## 2. Activating the Git Hook
@@ -82,6 +91,12 @@ pipenv run autohooks activate --mode pipenv
 autohooks activate --mode pythonpath
 ```
 ````
+
+````{group-tab} uv
+```bash
+uv run autohooks activate --mode uv
+```
+````
 `````
 
 ## 3. Installing and Configuring the Plugins to Be Run
@@ -111,7 +126,15 @@ python3 -m pip install --user autohooks-plugin-pylint
 autohooks plugins add autohooks.plugins.pylint
 ```
 ````
+
+````{group-tab} uv
+```bash
+uv add --dev autohooks-plugin-pylint
+uv run autohooks plugins add autohooks.plugins.pylint
+```
+````
 `````
 [pipenv]: https://pipenv.readthedocs.io/en/latest/
 [poetry]: https://python-poetry.org/
 [pip]: https://pip.pypa.io/en/stable/
+[uv]: https://docs.astral.sh/uv/
diff --git a/docs/modes.md b/docs/modes.md
@@ -5,6 +5,7 @@ Currently three modes for using autohooks are supported:
 * `pythonpath`
 * `poetry`
 * `pipenv`
+* `uv`
 
 These modes handle how autohooks, the plugins and their dependencies are loaded
 during git hook execution.
@@ -14,13 +15,13 @@ and no mode is set during [activation](./installation.md), autohooks
 will use the [pythonpath mode](#pythonpath-mode) by default.
 
 ```{note}
-`poetry` or `pipenv` modes leverage the `/usr/bin/env` command using the
+`poetry`, `pipenv` or `uv` modes leverage the `/usr/bin/env` command using the
 `--split-string` (`-S`) option. If `autohooks` detects that it is
 running on an OS where `/usr/bin/env` is yet to support _split_strings_
 (notably ubuntu < 19.x), `autohooks` will automatically change to an
-internally chosen `poetry_multiline`/`pipenv_mutliline` mode. The
+internally chosen `poetry_multiline`/`pipenv_mutliline`/`uv_multiline` mode. The
 'multiline' modes *should not* be user-configured options; setting your
-project to use `poetry` or `pipenv`allows team members the greatest
+project to use `poetry`, `pipenv` or `uv` allows team members the greatest
 latitude to use an OS of their choice yet leverage the sane
 `/usr/bin/env --split-string` if possible. Though `poetry_multiline`
 would generally work for all, it is very confusing sorcery.
@@ -44,7 +45,7 @@ this mode with a virtual environment is that [activating the environment](https:
 has to be done manually.
 
 To benefit from the advantages of a virtual environment a much better choice is
-to use [poetry] or [pipenv] for managing the virtual environment automatically.
+to use [poetry], [pipenv] or [uv] for managing the virtual environment automatically.
 
 ## Poetry Mode
 
@@ -67,5 +68,14 @@ installation is deterministic and reliable between different developer setups.
 In contrast to the `pythonpath` mode the activation of the virtual environment
 provided by [pipenv] is done automatically in the background.
 
+## uv Mode
+
+With the `uv` mode it is possible to run autohooks in a
+dedicated environment controlled by [uv]. By using the `uv` mode the
+virtual environment will be activated automatically in the background when
+executing the autohooks based git commit hook. All dependencies are managed
+by uv using the `pyproject.toml` and `uv.lock` files.
+
 [pipenv]: https://pipenv.readthedocs.io/en/latest/
 [poetry]: https://python-poetry.org/
+[uv]: https://docs.astral.sh/uv/
