mirror of
https://github.com/astral-sh/ruff.git
synced 2025-07-07 21:25:08 +00:00
5567e7c26b
## Summary Closes https://github.com/astral-sh/ruff/issues/15301#issuecomment-2573350821.
101 lines
2.6 KiB
Markdown
101 lines
2.6 KiB
Markdown
# Installing Ruff
|
|
|
|
Ruff is available as [`ruff`](https://pypi.org/project/ruff/) on PyPI.
|
|
|
|
Ruff can be invoked directly with [`uvx`](https://docs.astral.sh/uv/):
|
|
|
|
```shell
|
|
uvx ruff check # Lint all files in the current directory.
|
|
uvx ruff format # Format all files in the current directory.
|
|
```
|
|
|
|
Or installed with `uv` (recommended), `pip`, or `pipx`:
|
|
|
|
```console
|
|
$ # Install Ruff globally.
|
|
$ uv tool install ruff@latest
|
|
|
|
$ # Or add Ruff to your project.
|
|
$ uv add --dev ruff
|
|
|
|
$ # With pip.
|
|
$ pip install ruff
|
|
|
|
$ # With pipx.
|
|
$ pipx install ruff
|
|
```
|
|
|
|
Once installed, you can run Ruff from the command line:
|
|
|
|
```console
|
|
$ ruff check # Lint all files in the current directory.
|
|
$ ruff format # Format all files in the current directory.
|
|
```
|
|
|
|
Starting with version `0.5.0`, Ruff can also be installed with our standalone installers:
|
|
|
|
```console
|
|
$ # On macOS and Linux.
|
|
$ curl -LsSf https://astral.sh/ruff/install.sh | sh
|
|
|
|
$ # On Windows.
|
|
$ powershell -c "irm https://astral.sh/ruff/install.ps1 | iex"
|
|
|
|
$ # For a specific version.
|
|
$ curl -LsSf https://astral.sh/ruff/0.5.0/install.sh | sh
|
|
$ powershell -c "irm https://astral.sh/ruff/0.5.0/install.ps1 | iex"
|
|
```
|
|
|
|
For **macOS Homebrew** and **Linuxbrew** users, Ruff is also available
|
|
as [`ruff`](https://formulae.brew.sh/formula/ruff) on Homebrew:
|
|
|
|
```console
|
|
$ brew install ruff
|
|
```
|
|
|
|
For **Conda** users, Ruff is also available as [`ruff`](https://anaconda.org/conda-forge/ruff) on
|
|
`conda-forge`:
|
|
|
|
```console
|
|
$ conda install -c conda-forge ruff
|
|
```
|
|
|
|
For **pkgx** users, Ruff is also available as [`ruff`](https://pkgx.dev/pkgs/github.com/charliermarsh/ruff/)
|
|
on the `pkgx` registry:
|
|
|
|
```console
|
|
$ pkgx install ruff
|
|
```
|
|
|
|
For **Arch Linux** users, Ruff is also available as [`ruff`](https://archlinux.org/packages/extra/x86_64/ruff/)
|
|
on the official repositories:
|
|
|
|
```console
|
|
$ pacman -S ruff
|
|
```
|
|
|
|
For **Alpine** users, Ruff is also available as [`ruff`](https://pkgs.alpinelinux.org/package/edge/testing/x86_64/ruff)
|
|
on the testing repositories:
|
|
|
|
```console
|
|
$ apk add ruff
|
|
```
|
|
|
|
For **openSUSE Tumbleweed** users, Ruff is also available in the distribution repository:
|
|
|
|
```console
|
|
$ sudo zypper install python3-ruff
|
|
```
|
|
|
|
On **Docker**, it is published as `ghcr.io/astral-sh/ruff`, tagged for each release and `latest` for
|
|
the latest release.
|
|
|
|
```console
|
|
$ docker run -v .:/io --rm ghcr.io/astral-sh/ruff check
|
|
$ docker run -v .:/io --rm ghcr.io/astral-sh/ruff:0.3.0 check
|
|
|
|
$ # Or, for Podman on SELinux.
|
|
$ docker run -v .:/io:Z --rm ghcr.io/astral-sh/ruff check
|
|
```
|
|
|
|
[](https://repology.org/project/ruff-python-linter/versions)
|