mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-08-02 10:02:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add docs for uv tool install --editable (#11280)

Browse source 
I also moved it down a bit below the more important options

---------

Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>
This commit is contained in:
konsti 2025-02-07 23:56:54 +01:00 • committed by GitHub
parent 9e98b0e0f7
commit 96ac4b72b1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 17 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

20
crates/uv-cli/src/lib.rs
View file

@ -2798,7 +2798,7 @@ pub struct RunArgs {
#[arg(long)]
pub with: Vec<comma::CommaSeparatedRequirements>,
/// Run with the given packages installed as editables.
/// Run with the given packages installed in editable mode.
///
/// When used in a project, these dependencies will be layered on top of the project environment
/// in a separate, ephemeral environment. These dependencies are allowed to conflict with those
@ -3901,7 +3901,7 @@ pub struct ToolRunArgs {
#[arg(long)]
pub with: Vec<comma::CommaSeparatedRequirements>,
/// Run with the given packages installed as editables
/// Run with the given packages installed in editable mode
///
/// When used in a project, these dependencies will be layered on top of the uv tool's
/// environment in a separate, ephemeral environment. These dependencies are allowed to conflict
@ -3955,9 +3955,6 @@ pub struct ToolInstallArgs {
/// The package to install commands from.
pub package: String,
#[arg(short, long)]
pub editable: bool,
/// The package to install commands from.
///
/// This option is provided for parity with `uv tool run`, but is redundant with `package`.
@ -3968,14 +3965,19 @@ pub struct ToolInstallArgs {
#[arg(long)]
pub with: Vec<comma::CommaSeparatedRequirements>,
/// Include the given packages as editables.
#[arg(long)]
pub with_editable: Vec<comma::CommaSeparatedRequirements>,
/// Run all requirements listed in the given `requirements.txt` files.
#[arg(long, value_delimiter = ',', value_parser = parse_maybe_file_path)]
pub with_requirements: Vec<Maybe<PathBuf>>,
/// Install the target package in editable mode, such that changes in the package's source
/// directory are reflected without reinstallation.
#[arg(short, long)]
pub editable: bool,
/// Include the given packages in editable mode.
#[arg(long)]
pub with_editable: Vec<comma::CommaSeparatedRequirements>,
/// Constrain versions using the given requirements files.
///
/// Constraints files are `requirements.txt`-like files that only control the _version_ of a