Skip to content

Clarify --project flag help text to indicate project discovery #16965

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
zanieb merged 3 commits into from
Dec 3, 2025
Merged

Clarify --project flag help text to indicate project discovery #16965

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c83c98
Clarify `--project` flag help text to indicate project discovery
nooscraft Dec 3, 2025
cb7769f
Update generated CLI documentation
nooscraft Dec 3, 2025
e489cbf
Update help snapshot tests for --project flag description
nooscraft Dec 3, 2025
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
2 changes: 1 addition & 1 deletion crates/uv-cli/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ pub struct GlobalArgs {
#[arg(global = true, long, env = EnvVars::UV_WORKING_DIR)]
pub directory: Option<PathBuf>,

/// Run the command within the given project directory.
/// Discover a project in the given directory.
///
/// All `pyproject.toml`, `uv.toml`, and `.python-version` files will be discovered by walking
/// up the directory tree from the project root, as will the project's virtual environment
Expand Down
18 changes: 9 additions & 9 deletions crates/uv/tests/it/help.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ fn help() {
--directory <DIRECTORY>
Change to the given directory prior to running the command [env: UV_WORKING_DIR=]
--project <PROJECT>
Run the command within the given project directory [env: UV_PROJECT=]
Discover a project in the given directory [env: UV_PROJECT=]
--config-file <CONFIG_FILE>
The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=]
--no-config
Expand Down Expand Up @@ -149,7 +149,7 @@ fn help_flag() {
--directory <DIRECTORY>
Change to the given directory prior to running the command [env: UV_WORKING_DIR=]
--project <PROJECT>
Run the command within the given project directory [env: UV_PROJECT=]
Discover a project in the given directory [env: UV_PROJECT=]
--config-file <CONFIG_FILE>
The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=]
--no-config
Expand Down Expand Up @@ -229,7 +229,7 @@ fn help_short_flag() {
--directory <DIRECTORY>
Change to the given directory prior to running the command [env: UV_WORKING_DIR=]
--project <PROJECT>
Run the command within the given project directory [env: UV_PROJECT=]
Discover a project in the given directory [env: UV_PROJECT=]
--config-file <CONFIG_FILE>
The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=]
--no-config
Expand Down Expand Up @@ -419,7 +419,7 @@ fn help_subcommand() {
[env: UV_WORKING_DIR=]

--project <PROJECT>
Run the command within the given project directory.
Discover a project in the given directory.

All `pyproject.toml`, `uv.toml`, and `.python-version` files will be discovered by walking
up the directory tree from the project root, as will the project's virtual environment
Expand Down Expand Up @@ -692,7 +692,7 @@ fn help_subsubcommand() {
[env: UV_WORKING_DIR=]

--project <PROJECT>
Run the command within the given project directory.
Discover a project in the given directory.

All `pyproject.toml`, `uv.toml`, and `.python-version` files will be discovered by walking
up the directory tree from the project root, as will the project's virtual environment
Expand Down Expand Up @@ -783,7 +783,7 @@ fn help_flag_subcommand() {
--directory <DIRECTORY>
Change to the given directory prior to running the command [env: UV_WORKING_DIR=]
--project <PROJECT>
Run the command within the given project directory [env: UV_PROJECT=]
Discover a project in the given directory [env: UV_PROJECT=]
--config-file <CONFIG_FILE>
The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=]
--no-config
Expand Down Expand Up @@ -864,7 +864,7 @@ fn help_flag_subsubcommand() {
--directory <DIRECTORY>
Change to the given directory prior to running the command [env: UV_WORKING_DIR=]
--project <PROJECT>
Run the command within the given project directory [env: UV_PROJECT=]
Discover a project in the given directory [env: UV_PROJECT=]
--config-file <CONFIG_FILE>
The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=]
--no-config
Expand Down Expand Up @@ -1026,7 +1026,7 @@ fn help_with_global_option() {
--directory <DIRECTORY>
Change to the given directory prior to running the command [env: UV_WORKING_DIR=]
--project <PROJECT>
Run the command within the given project directory [env: UV_PROJECT=]
Discover a project in the given directory [env: UV_PROJECT=]
--config-file <CONFIG_FILE>
The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=]
--no-config
Expand Down Expand Up @@ -1149,7 +1149,7 @@ fn help_with_no_pager() {
--directory <DIRECTORY>
Change to the given directory prior to running the command [env: UV_WORKING_DIR=]
--project <PROJECT>
Run the command within the given project directory [env: UV_PROJECT=]
Discover a project in the given directory [env: UV_PROJECT=]
--config-file <CONFIG_FILE>
The path to a `uv.toml` file to use for configuration [env: UV_CONFIG_FILE=]
--no-config
Expand Down
Loading
Loading