Skip to content

Document - stdin convention in CLI help text #22817

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 1 commit into from
Jan 23, 2026
+8 −4
Merged

Document - stdin convention in CLI help text #22817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions crates/ruff/src/args.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ pub struct AnalyzeGraphCommand {
#[expect(clippy::struct_excessive_bools)]
pub struct CheckCommand {
/// List of files or directories to check.
#[clap(help = "List of files or directories to check [default: .]")]
#[clap(help = "List of files or directories to check, or `-` to read from stdin [default: .]")]
pub files: Vec<PathBuf>,
/// Apply fixes to resolve lint violations.
/// Use `--no-fix` to disable or `--unsafe-fixes` to include unsafe fixes.
Expand Down Expand Up @@ -475,7 +475,9 @@ pub struct CheckCommand {
#[expect(clippy::struct_excessive_bools)]
pub struct FormatCommand {
/// List of files or directories to format.
#[clap(help = "List of files or directories to format [default: .]")]
#[clap(
help = "List of files or directories to format, or `-` to read from stdin [default: .]"
)]
pub files: Vec<PathBuf>,
/// Avoid writing any formatted files back; instead, exit with a non-zero status code if any
/// files would have been modified, and zero otherwise.
Expand Down
6 changes: 4 additions & 2 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,8 @@ Run Ruff on the given files or directories
Usage: ruff check [OPTIONS] [FILES]...

Arguments:
[FILES]... List of files or directories to check [default: .]
[FILES]... List of files or directories to check, or `-` to read from stdin
[default: .]

Options:
--fix
Expand Down Expand Up @@ -710,7 +711,8 @@ Run the Ruff formatter on the given files or directories
Usage: ruff format [OPTIONS] [FILES]...

Arguments:
[FILES]... List of files or directories to format [default: .]
[FILES]... List of files or directories to format, or `-` to read from stdin
[default: .]

Options:
--check
Expand Down