mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-10-13 20:12:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

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)] #[arg(long)]
pub with: Vec<comma::CommaSeparatedRequirements>, 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 /// 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 /// in a separate, ephemeral environment. These dependencies are allowed to conflict with those
@ -3901,7 +3901,7 @@ pub struct ToolRunArgs {
#[arg(long)] #[arg(long)]
pub with: Vec<comma::CommaSeparatedRequirements>, 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 /// 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 /// 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. /// The package to install commands from.
pub package: String, pub package: String,
#[arg(short, long)]
pub editable: bool,
/// The package to install commands from. /// The package to install commands from.
/// ///
/// This option is provided for parity with `uv tool run`, but is redundant with `package`. /// This option is provided for parity with `uv tool run`, but is redundant with `package`.
@ -3968,14 +3965,19 @@ pub struct ToolInstallArgs {
#[arg(long)] #[arg(long)]
pub with: Vec<comma::CommaSeparatedRequirements>, 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. /// Run all requirements listed in the given `requirements.txt` files.
#[arg(long, value_delimiter = ',', value_parser = parse_maybe_file_path)] #[arg(long, value_delimiter = ',', value_parser = parse_maybe_file_path)]
pub with_requirements: Vec<Maybe<PathBuf>>, 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. /// Constrain versions using the given requirements files.
/// ///
/// Constraints files are `requirements.txt`-like files that only control the _version_ of a /// Constraints files are `requirements.txt`-like files that only control the _version_ of a

10
docs/reference/cli.md
View file

@ -485,7 +485,7 @@ uv run [OPTIONS] [COMMAND]
<p>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 specified by the project.</p> <p>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 specified by the project.</p>
</dd><dt><code>--with-editable</code> <i>with-editable</i></dt><dd><p>Run with the given packages installed as editables.</p> </dd><dt><code>--with-editable</code> <i>with-editable</i></dt><dd><p>Run with the given packages installed in editable mode.</p>
<p>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 specified by the project.</p> <p>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 specified by the project.</p>
@ -3381,7 +3381,7 @@ uv tool run [OPTIONS] [COMMAND]
</dd><dt><code>--with</code> <i>with</i></dt><dd><p>Run with the given packages installed</p> </dd><dt><code>--with</code> <i>with</i></dt><dd><p>Run with the given packages installed</p>
</dd><dt><code>--with-editable</code> <i>with-editable</i></dt><dd><p>Run with the given packages installed as editables</p> </dd><dt><code>--with-editable</code> <i>with-editable</i></dt><dd><p>Run with the given packages installed in editable mode</p>
<p>When used in a project, these dependencies will be layered on top of the uv tool&#8217;s environment in a separate, ephemeral environment. These dependencies are allowed to conflict with those specified.</p> <p>When used in a project, these dependencies will be layered on top of the uv tool&#8217;s environment in a separate, ephemeral environment. These dependencies are allowed to conflict with those specified.</p>
@ -3474,7 +3474,9 @@ uv tool install [OPTIONS] <PACKAGE>
<p>See <code>--project</code> to only change the project root directory.</p> <p>See <code>--project</code> to only change the project root directory.</p>
</dd><dt><code>--editable</code>, <code>-e</code></dt><dt><code>--exclude-newer</code> <i>exclude-newer</i></dt><dd><p>Limit candidate packages to those that were uploaded prior to the given date.</p> </dd><dt><code>--editable</code>, <code>-e</code></dt><dd><p>Install the target package in editable mode, such that changes in the package&#8217;s source directory are reflected without reinstallation</p>
</dd><dt><code>--exclude-newer</code> <i>exclude-newer</i></dt><dd><p>Limit candidate packages to those that were uploaded prior to the given date.</p>
<p>Accepts both RFC 3339 timestamps (e.g., <code>2006-12-02T02:07:43Z</code>) and local dates in the same format (e.g., <code>2006-12-02</code>) in your system&#8217;s configured time zone.</p> <p>Accepts both RFC 3339 timestamps (e.g., <code>2006-12-02T02:07:43Z</code>) and local dates in the same format (e.g., <code>2006-12-02</code>) in your system&#8217;s configured time zone.</p>
@ -3715,7 +3717,7 @@ uv tool install [OPTIONS] <PACKAGE>
</dd><dt><code>--with</code> <i>with</i></dt><dd><p>Include the following extra requirements</p> </dd><dt><code>--with</code> <i>with</i></dt><dd><p>Include the following extra requirements</p>
</dd><dt><code>--with-editable</code> <i>with-editable</i></dt><dd><p>Include the given packages as editables</p> </dd><dt><code>--with-editable</code> <i>with-editable</i></dt><dd><p>Include the given packages in editable mode</p>
</dd><dt><code>--with-requirements</code> <i>with-requirements</i></dt><dd><p>Run all requirements listed in the given <code>requirements.txt</code> files</p> </dd><dt><code>--with-requirements</code> <i>with-requirements</i></dt><dd><p>Run all requirements listed in the given <code>requirements.txt</code> files</p>