mirror of
https://github.com/astral-sh/ruff.git
synced 2025-08-04 10:48:32 +00:00
2bf1882398
## Summary This PR modifies the documentation to use `ruff check` instead of `ruff check .`, and `ruff format` instead of `ruff format .`, as discussed [here](https://github.com/astral-sh/ruff/pull/10168#discussion_r1509976904) --------- Co-authored-by: Micha Reiser <micha@reiser.io> Co-authored-by: Zanie Blue <contact@zanie.dev>
1.7 KiB
1.7 KiB
Installing Ruff
Ruff is available as ruff on PyPI:
pip install ruff
Once installed, you can run Ruff from the command line:
ruff check # Lint all files in the current directory.
ruff format # Format all files in the current directory.
For macOS Homebrew and Linuxbrew users, Ruff is also available as ruff
on Homebrew:
brew install ruff
For Conda users, Ruff is also available as ruff on
conda-forge:
conda install -c conda-forge ruff
For pkgx users, Ruff is also available as ruff
on the pkgx registry:
pkgx install ruff
For Arch Linux users, Ruff is also available as ruff
on the official repositories:
pacman -S ruff
For Alpine users, Ruff is also available as ruff
on the testing repositories:
apk add ruff
For openSUSE Tumbleweed users, Ruff is also available in the distribution repository:
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.
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
