Ruff can be configured through a pyproject.toml
, ruff.toml
, or .ruff.toml
file.
Whether you're using Ruff as a linter, formatter, or both, the underlying configuration strategy and semantics are the same.
For a complete enumeration of the available configuration options, see Settings.
If left unspecified, Ruff's default configuration is equivalent to:
[tool.ruff]
# Exclude a variety of commonly ignored directories.
exclude = [
".bzr",
".direnv",
".eggs",
".git",
".git-rewrite",
".hg",
".mypy_cache",
".nox",
".pants.d",
".pytype",
".ruff_cache",
".svn",
".tox",
".venv",
"__pypackages__",
"_build",
"buck-out",
"build",
"dist",
"node_modules",
"venv",
]
# Same as Black.
line-length = 88
indent-width = 4
# Assume Python 3.8
target-version = "py38"
[tool.ruff.lint]
# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default.
# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
# McCabe complexity (`C901`) by default.
select = ["E4", "E7", "E9", "F"]
ignore = []
# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []
# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
[tool.ruff.format]
# Like Black, use double quotes for strings.
quote-style = "double"
# Like Black, indent with spaces, rather than tabs.
indent-style = "space"
# Like Black, respect magic trailing commas.
magic-trailing-comma = "respect"
# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"
As an example, the following would configure Ruff to:
[tool.ruff.lint]
# 1. Enable flake8-bugbear (`B`) rules, in addition to the defaults.
select = ["E", "F", "B"]
# 2. Avoid enforcing line-length violations (`E501`)
ignore = ["E501"]
# 3. Avoid trying to fix flake8-bugbear (`B`) violations.
unfixable = ["B"]
# 4. Ignore `E402` (import violations) in all `__init__.py` files, and in select subdirectories.
[tool.ruff.lint.per-file-ignores]
"__init__.py" = ["E402"]
"**/{tests,docs,tools}/*" = ["E402"]
[tool.ruff.format]
# 5. Use single quotes for non-triple-quoted strings.
quote-style = "single"
Linter plugin configurations are expressed as subsections, e.g.:
[tool.ruff.lint]
# Add "Q" to the list of enabled codes.
select = ["E", "F", "Q"]
[tool.ruff.lint.flake8-quotes]
docstring-quotes = "double"
For a complete enumeration of the available configuration options, see Settings.
As an alternative to pyproject.toml
, Ruff will also respect a ruff.toml
(or .ruff.toml
) file,
which implements an equivalent schema (though in the ruff.toml
and .ruff.toml
versions, the
[tool.ruff]
header is omitted).
For example, the pyproject.toml
described above would be represented via the following
ruff.toml
(or .ruff.toml
):
[lint]
# Enable flake8-bugbear (`B`) rules.
select = ["E", "F", "B"]
# Never enforce `E501` (line length violations).
ignore = ["E501"]
# Avoid trying to fix flake8-bugbear (`B`) violations.
unfixable = ["B"]
# Ignore `E402` (import violations) in all `__init__.py` files, and in select subdirectories.
[lint.per-file-ignores]
"__init__.py" = ["E402"]
"**/{tests,docs,tools}/*" = ["E402"]
[format]
# Use single quotes for non-triple-quoted strings.
quote-style = "single"
For a complete enumeration of the available configuration options, see Settings.
Similar to ESLint,
Ruff supports hierarchical configuration, such that the "closest" pyproject.toml
file in the
directory hierarchy is used for every individual file, with all paths in the pyproject.toml
file
(e.g., exclude
globs, src
paths) being resolved relative to the directory containing that
pyproject.toml
file.
There are a few exceptions to these rules:
- In locating the "closest"
pyproject.toml
file for a given path, Ruff ignores anypyproject.toml
files that lack a[tool.ruff]
section. - If a configuration file is passed directly via
--config
, those settings are used for all analyzed files, and any relative paths in that configuration file (likeexclude
globs orsrc
paths) are resolved relative to the current working directory. - If no
pyproject.toml
file is found in the filesystem hierarchy, Ruff will fall back to using a default configuration. If a user-specific configuration file exists at${config_dir}/ruff/pyproject.toml
, that file will be used instead of the default configuration, with${config_dir}
being determined via thedirs
crate, and all relative paths being again resolved relative to the current working directory. - Any
pyproject.toml
-supported settings that are provided on the command-line (e.g., via--select
) will override the settings in every resolved configuration file.
Unlike ESLint,
Ruff does not merge settings across configuration files; instead, the "closest" configuration file
is used, and any parent configuration files are ignored. In lieu of this implicit cascade, Ruff
supports an extend
field, which allows you to inherit the settings from another
pyproject.toml
file, like so:
[tool.ruff]
# Extend the `pyproject.toml` file in the parent directory...
extend = "../pyproject.toml"
# ...but use a different line length.
line-length = 100
All of the above rules apply equivalently to ruff.toml
and .ruff.toml
files. If Ruff detects
multiple configuration files in the same directory, the .ruff.toml
file will take precedence over
the ruff.toml
file, and the ruff.toml
file will take precedence over the pyproject.toml
file.
When passed a path on the command-line, Ruff will automatically discover all Python files in that
path, taking into account the exclude
and extend-exclude
settings in each directory's pyproject.toml
file.
Files can also be selectively excluded from linting or formatting by scoping the exclude
and
extend-exclude
settings to the tool-specific configuration tables. For example, the following
would prevent ruff
from formatting .pyi
files, but would continue to include them in linting:
[tool.ruff.format]
extend-exclude = ["*.pyi"]
By default, Ruff will also skip any files that are omitted via .ignore
, .gitignore
,
.git/info/exclude
, and global gitignore
files (see: respect-gitignore
).
Files that are passed to ruff
directly are always analyzed, regardless of the above criteria.
For example, ruff check /path/to/excluded/file.py
will always lint file.py
.
Ruff has built-in support for Jupyter Notebooks.
To opt in to linting and formatting Jupyter Notebook (.ipynb
) files, add the *.ipynb
pattern to
your extend-include
setting, like so:
[tool.ruff]
extend-include = ["*.ipynb"]
This will prompt Ruff to discover Jupyter Notebook (.ipynb
) files in any specified
directories, then lint and format them accordingly.
Alternatively, pass the notebook file(s) to ruff
on the command-line directly. For example,
ruff check /path/to/notebook.ipynb
will always lint notebook.ipynb
. Similarly,
ruff format /path/to/notebook.ipynb
will always format notebook.ipynb
.
All of the above rules apply equivalently to ruff.toml
and .ruff.toml
files. If Ruff detects
multiple configuration files in the same directory, the .ruff.toml
file will take precedence over
the ruff.toml
file, and the ruff.toml
file will take precedence over the pyproject.toml
file.
Some configuration options can be provided via the command-line, such as those related to rule enablement and disablement, file discovery, logging level, and more:
ruff check path/to/code/ --select F401 --select F403 --quiet
See ruff help
for more on Ruff's top-level commands:
Ruff: An extremely fast Python linter.
Usage: ruff [OPTIONS] <COMMAND>
Commands:
check Run Ruff on the given files or directories (default)
rule Explain a rule (or all rules)
config List or describe the available configuration options
linter List all supported upstream linters
clean Clear any caches in the current directory and any subdirectories
format Run the Ruff formatter on the given files or directories
version Display Ruff's version
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
Log levels:
-v, --verbose Enable verbose logging
-q, --quiet Print diagnostics, but nothing else
-s, --silent Disable all logging (but still exit with status code "1" upon detecting diagnostics)
For help with a specific command, see: `ruff help <command>`.
Or ruff help check
for more on the linting command:
Run Ruff on the given files or directories (default)
Usage: ruff check [OPTIONS] [FILES]...
Arguments:
[FILES]... List of files or directories to check
Options:
--fix
Apply fixes to resolve lint violations. Use `--no-fix` to disable or `--unsafe-fixes` to include unsafe fixes
--unsafe-fixes
Include fixes that may not retain the original intent of the code. Use `--no-unsafe-fixes` to disable
--show-source
Show violations with source code. Use `--no-show-source` to disable
--show-fixes
Show an enumeration of all fixed lint violations. Use `--no-show-fixes` to disable
--diff
Avoid writing any fixed files back; instead, output a diff for each changed file to stdout. Implies `--fix-only`
-w, --watch
Run in watch mode by re-running whenever files change
--fix-only
Apply fixes to resolve lint violations, but don't report on leftover violations. Implies `--fix`. Use `--no-fix-only` to disable or `--unsafe-fixes` to include unsafe fixes
--ignore-noqa
Ignore any `# noqa` comments
--output-format <OUTPUT_FORMAT>
Output serialization format for violations [env: RUFF_OUTPUT_FORMAT=] [possible values: text, json, json-lines, junit, grouped, github, gitlab, pylint, azure]
-o, --output-file <OUTPUT_FILE>
Specify file to write the linter output to (default: stdout)
--target-version <TARGET_VERSION>
The minimum Python version that should be supported [possible values: py37, py38, py39, py310, py311, py312]
--preview
Enable preview mode; checks will include unstable rules and fixes. Use `--no-preview` to disable
--config <CONFIG>
Path to the `pyproject.toml` or `ruff.toml` file to use for configuration
--statistics
Show counts for every rule with at least one violation
--add-noqa
Enable automatic additions of `noqa` directives to failing lines
--show-files
See the files Ruff will be run against with the current settings
--show-settings
See the settings Ruff will use to lint a given Python file
-h, --help
Print help
Rule selection:
--select <RULE_CODE>
Comma-separated list of rule codes to enable (or ALL, to enable all rules)
--ignore <RULE_CODE>
Comma-separated list of rule codes to disable
--extend-select <RULE_CODE>
Like --select, but adds additional rule codes on top of those already specified
--per-file-ignores <PER_FILE_IGNORES>
List of mappings from file pattern to code to exclude
--extend-per-file-ignores <EXTEND_PER_FILE_IGNORES>
Like `--per-file-ignores`, but adds additional ignores on top of those already specified
--fixable <RULE_CODE>
List of rule codes to treat as eligible for fix. Only applicable when fix itself is enabled (e.g., via `--fix`)
--unfixable <RULE_CODE>
List of rule codes to treat as ineligible for fix. Only applicable when fix itself is enabled (e.g., via `--fix`)
--extend-fixable <RULE_CODE>
Like --fixable, but adds additional rule codes on top of those already specified
File selection:
--exclude <FILE_PATTERN> List of paths, used to omit files and/or directories from analysis
--extend-exclude <FILE_PATTERN> Like --exclude, but adds additional files and directories on top of those already excluded
--respect-gitignore Respect file exclusions via `.gitignore` and other standard ignore files. Use `--no-respect-gitignore` to disable
--force-exclude Enforce exclusions, even for paths passed to Ruff directly on the command-line. Use `--no-force-exclude` to disable
Miscellaneous:
-n, --no-cache
Disable cache reads
--isolated
Ignore all configuration files
--cache-dir <CACHE_DIR>
Path to the cache directory [env: RUFF_CACHE_DIR=]
--stdin-filename <STDIN_FILENAME>
The name of the file when passing it through stdin
-e, --exit-zero
Exit with status code "0", even upon detecting lint violations
--exit-non-zero-on-fix
Exit with a non-zero status code if any files were modified via fix, even if no lint violations remain
Log levels:
-v, --verbose Enable verbose logging
-q, --quiet Print diagnostics, but nothing else
-s, --silent Disable all logging (but still exit with status code "1" upon detecting diagnostics)
Or ruff help format
for more on the formatting command:
Run the Ruff formatter on the given files or directories
Usage: ruff format [OPTIONS] [FILES]...
Arguments:
[FILES]... List of files or directories to format
Options:
--check
Avoid writing any formatted files back; instead, exit with a non-zero status code if any files would have been modified, and zero otherwise
--diff
Avoid writing any formatted files back; instead, exit with a non-zero status code and the difference between the current file and how the formatted file would look like
--config <CONFIG>
Path to the `pyproject.toml` or `ruff.toml` file to use for configuration
--target-version <TARGET_VERSION>
The minimum Python version that should be supported [possible values: py37, py38, py39, py310, py311, py312]
--preview
Enable preview mode; enables unstable formatting. Use `--no-preview` to disable
-h, --help
Print help
Miscellaneous:
-n, --no-cache Disable cache reads
--cache-dir <CACHE_DIR> Path to the cache directory [env: RUFF_CACHE_DIR=]
--isolated Ignore all configuration files
--stdin-filename <STDIN_FILENAME> The name of the file when passing it through stdin
File selection:
--respect-gitignore Respect file exclusions via `.gitignore` and other standard ignore files. Use `--no-respect-gitignore` to disable
--exclude <FILE_PATTERN> List of paths, used to omit files and/or directories from analysis
--force-exclude Enforce exclusions, even for paths passed to Ruff directly on the command-line. Use `--no-force-exclude` to disable
Log levels:
-v, --verbose Enable verbose logging
-q, --quiet Print diagnostics, but nothing else
-s, --silent Disable all logging (but still exit with status code "1" upon detecting diagnostics)
Ruff supports autocompletion for most shells. A shell-specific completion script can be generated
by ruff generate-shell-completion <SHELL>
, where <SHELL>
is one of bash
, elvish
, fig
, fish
,
powershell
, or zsh
.
The exact steps required to enable autocompletion will vary by shell. For example instructions, see the Poetry or ripgrep documentation.
As an example: to enable autocompletion for Zsh, run
ruff generate-shell-completion zsh > ~/.zfunc/_ruff
. Then add the following line to your
~/.zshrc
file, if they're not already present:
fpath+=~/.zfunc
autoload -Uz compinit && compinit