Skip to content

Document argfile support #26803

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ntBre merged 2 commits into from
Jul 16, 2026
+18 −0
Merged

Document argfile support #26803

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e09632e
docs: Document argfile support (#21894)
Joosboy Jul 14, 2026
670ec13
docs: Move argfile section after config details
Joosboy Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,6 +516,24 @@ which will similarly override the `line-length` setting from
all configuration files detected by Ruff, regardless of where
a specific configuration file is located.

### Argfile support

Ruff supports reading command-line arguments from a file, which is especially useful when passing a large number of file paths that might exceed your shell's command-line length limit. To use an argfile, prefix the file path with an `@` symbol:

```console
$ ruff check @path/to/args.txt
```

The arguments in the file must all be written on their own line. For example, `args.txt` might contain:

```text
--select
F401
--quiet
path/to/code1/
path/to/code2/
```

### Full command-line interface

See `ruff help` for the full list of Ruff's top-level commands:
Expand Down
Loading