mirror of
https://github.com/astral-sh/uv.git
synced 2025-08-04 10:58:28 +00:00
Unhide the --directory option (#7653)
This commit is contained in:
Zanie Blue
GitHub
parent
5da73a24cb
commit
0c6117f5da
3 changed files with 337 additions and 2 deletions
|
|
@ -234,7 +234,11 @@ pub struct GlobalArgs {
|
|||
pub no_progress: bool,
|
||||
|
||||
/// Change to the given directory prior to running the command.
|
||||
#[arg(global = true, long, hide = true)]
|
||||
///
|
||||
/// Relative paths are resolved with the given directory as the base.
|
||||
///
|
||||
/// See `--project` to only change the project root directory.
|
||||
#[arg(global = true, long)]
|
||||
pub directory: Option<PathBuf>,
|
||||
|
||||
/// Run the command within the given project directory.
|
||||
|
|
@ -246,6 +250,8 @@ pub struct GlobalArgs {
|
|||
/// Other command-line arguments (such as relative paths) will be resolved relative
|
||||
/// to the current working directory.
|
||||
///
|
||||
/// See `--directory` to change the working directory entirely.
|
||||
///
|
||||
/// This setting has no effect when used in the `uv pip` interface.
|
||||
#[arg(global = true, long)]
|
||||
pub project: Option<PathBuf>,
|
||||
|
|
|
|||
|
|
@ -56,6 +56,7 @@ fn help() {
|
|||
certificate store [env: UV_NATIVE_TLS=]
|
||||
--offline Disable network access
|
||||
--no-progress Hide all progress outputs
|
||||
--directory <DIRECTORY> Change to the given directory prior to running the command
|
||||
--project <PROJECT> Run the command within the given project directory
|
||||
--config-file <CONFIG_FILE> The path to a `uv.toml` file to use for configuration [env:
|
||||
UV_CONFIG_FILE=]
|
||||
|
|
@ -122,6 +123,7 @@ fn help_flag() {
|
|||
certificate store [env: UV_NATIVE_TLS=]
|
||||
--offline Disable network access
|
||||
--no-progress Hide all progress outputs
|
||||
--directory <DIRECTORY> Change to the given directory prior to running the command
|
||||
--project <PROJECT> Run the command within the given project directory
|
||||
--config-file <CONFIG_FILE> The path to a `uv.toml` file to use for configuration [env:
|
||||
UV_CONFIG_FILE=]
|
||||
|
|
@ -187,6 +189,7 @@ fn help_short_flag() {
|
|||
certificate store [env: UV_NATIVE_TLS=]
|
||||
--offline Disable network access
|
||||
--no-progress Hide all progress outputs
|
||||
--directory <DIRECTORY> Change to the given directory prior to running the command
|
||||
--project <PROJECT> Run the command within the given project directory
|
||||
--config-file <CONFIG_FILE> The path to a `uv.toml` file to use for configuration [env:
|
||||
UV_CONFIG_FILE=]
|
||||
|
|
@ -339,6 +342,13 @@ fn help_subcommand() {
|
|||
|
||||
For example, spinners or progress bars.
|
||||
|
||||
--directory <DIRECTORY>
|
||||
Change to the given directory prior to running the command.
|
||||
|
||||
Relative paths are resolved with the given directory as the base.
|
||||
|
||||
See `--project` to only change the project root directory.
|
||||
|
||||
--project <PROJECT>
|
||||
Run the command within the given project directory.
|
||||
|
||||
|
|
@ -349,6 +359,8 @@ fn help_subcommand() {
|
|||
Other command-line arguments (such as relative paths) will be resolved relative to the
|
||||
current working directory.
|
||||
|
||||
See `--directory` to change the working directory entirely.
|
||||
|
||||
This setting has no effect when used in the `uv pip` interface.
|
||||
|
||||
--config-file <CONFIG_FILE>
|
||||
|
|
@ -500,6 +512,13 @@ fn help_subsubcommand() {
|
|||
|
||||
For example, spinners or progress bars.
|
||||
|
||||
--directory <DIRECTORY>
|
||||
Change to the given directory prior to running the command.
|
||||
|
||||
Relative paths are resolved with the given directory as the base.
|
||||
|
||||
See `--project` to only change the project root directory.
|
||||
|
||||
--project <PROJECT>
|
||||
Run the command within the given project directory.
|
||||
|
||||
|
|
@ -510,6 +529,8 @@ fn help_subsubcommand() {
|
|||
Other command-line arguments (such as relative paths) will be resolved relative to the
|
||||
current working directory.
|
||||
|
||||
See `--directory` to change the working directory entirely.
|
||||
|
||||
This setting has no effect when used in the `uv pip` interface.
|
||||
|
||||
--config-file <CONFIG_FILE>
|
||||
|
|
@ -580,6 +601,7 @@ fn help_flag_subcommand() {
|
|||
certificate store [env: UV_NATIVE_TLS=]
|
||||
--offline Disable network access
|
||||
--no-progress Hide all progress outputs
|
||||
--directory <DIRECTORY> Change to the given directory prior to running the command
|
||||
--project <PROJECT> Run the command within the given project directory
|
||||
--config-file <CONFIG_FILE> The path to a `uv.toml` file to use for configuration [env:
|
||||
UV_CONFIG_FILE=]
|
||||
|
|
@ -633,6 +655,7 @@ fn help_flag_subsubcommand() {
|
|||
certificate store [env: UV_NATIVE_TLS=]
|
||||
--offline Disable network access
|
||||
--no-progress Hide all progress outputs
|
||||
--directory <DIRECTORY> Change to the given directory prior to running the command
|
||||
--project <PROJECT> Run the command within the given project directory
|
||||
--config-file <CONFIG_FILE> The path to a `uv.toml` file to use for configuration [env:
|
||||
UV_CONFIG_FILE=]
|
||||
|
|
@ -775,6 +798,7 @@ fn help_with_global_option() {
|
|||
certificate store [env: UV_NATIVE_TLS=]
|
||||
--offline Disable network access
|
||||
--no-progress Hide all progress outputs
|
||||
--directory <DIRECTORY> Change to the given directory prior to running the command
|
||||
--project <PROJECT> Run the command within the given project directory
|
||||
--config-file <CONFIG_FILE> The path to a `uv.toml` file to use for configuration [env:
|
||||
UV_CONFIG_FILE=]
|
||||
|
|
@ -878,6 +902,7 @@ fn help_with_no_pager() {
|
|||
certificate store [env: UV_NATIVE_TLS=]
|
||||
--offline Disable network access
|
||||
--no-progress Hide all progress outputs
|
||||
--directory <DIRECTORY> Change to the given directory prior to running the command
|
||||
--project <PROJECT> Run the command within the given project directory
|
||||
--config-file <CONFIG_FILE> The path to a `uv.toml` file to use for configuration [env:
|
||||
UV_CONFIG_FILE=]
|
||||
|
|
|
|||
|
|
@ -116,6 +116,12 @@ uv run [OPTIONS] <COMMAND>
|
|||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--config-setting</code>, <code>-C</code> <i>config-setting</i></dt><dd><p>Settings to pass to the PEP 517 build backend, specified as <code>KEY=VALUE</code> pairs</p>
|
||||
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</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’s configured time zone.</p>
|
||||
|
|
@ -309,6 +315,8 @@ uv run [OPTIONS] <COMMAND>
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use for the run environment.</p>
|
||||
|
|
@ -444,6 +452,12 @@ uv init [OPTIONS] [PATH]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--lib</code></dt><dd><p>Create a project for a library.</p>
|
||||
|
|
@ -509,6 +523,8 @@ uv init [OPTIONS] [PATH]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use to determine the minimum supported Python version.</p>
|
||||
|
|
@ -616,6 +632,12 @@ uv add [OPTIONS] <PACKAGES|--requirements <REQUIREMENTS>>
|
|||
|
||||
</dd><dt><code>--dev</code></dt><dd><p>Add the requirements as development dependencies</p>
|
||||
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--editable</code></dt><dd><p>Add the requirements as editable</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>
|
||||
|
|
@ -787,6 +809,8 @@ uv add [OPTIONS] <PACKAGES|--requirements <REQUIREMENTS>>
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use for resolving and syncing.</p>
|
||||
|
|
@ -932,6 +956,12 @@ uv remove [OPTIONS] <PACKAGES>...
|
|||
|
||||
</dd><dt><code>--dev</code></dt><dd><p>Remove the packages from the development dependencies</p>
|
||||
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</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’s configured time zone.</p>
|
||||
|
|
@ -1091,6 +1121,8 @@ uv remove [OPTIONS] <PACKAGES>...
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use for resolving and syncing.</p>
|
||||
|
|
@ -1222,6 +1254,12 @@ uv sync [OPTIONS]
|
|||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--config-setting</code>, <code>-C</code> <i>config-setting</i></dt><dd><p>Settings to pass to the PEP 517 build backend, specified as <code>KEY=VALUE</code> pairs</p>
|
||||
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</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’s configured time zone.</p>
|
||||
|
|
@ -1411,6 +1449,8 @@ uv sync [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use for the project environment.</p>
|
||||
|
|
@ -1523,6 +1563,12 @@ uv lock [OPTIONS]
|
|||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--config-setting</code>, <code>-C</code> <i>config-setting</i></dt><dd><p>Settings to pass to the PEP 517 build backend, specified as <code>KEY=VALUE</code> pairs</p>
|
||||
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</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’s configured time zone.</p>
|
||||
|
|
@ -1676,6 +1722,8 @@ uv lock [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use during resolution.</p>
|
||||
|
|
@ -1790,6 +1838,12 @@ uv export [OPTIONS]
|
|||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--config-setting</code>, <code>-C</code> <i>config-setting</i></dt><dd><p>Settings to pass to the PEP 517 build backend, specified as <code>KEY=VALUE</code> pairs</p>
|
||||
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</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’s configured time zone.</p>
|
||||
|
|
@ -1987,6 +2041,8 @@ uv export [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use during resolution.</p>
|
||||
|
|
@ -2094,6 +2150,12 @@ uv tree [OPTIONS]
|
|||
</dd><dt><code>--depth</code>, <code>-d</code> <i>depth</i></dt><dd><p>Maximum display depth of the dependency tree</p>
|
||||
|
||||
<p>[default: 255]</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</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’s configured time zone.</p>
|
||||
|
|
@ -2255,6 +2317,8 @@ uv tree [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--prune</code> <i>prune</i></dt><dd><p>Prune the given package from the display of the dependency tree</p>
|
||||
|
|
@ -2457,6 +2521,12 @@ uv tool run [OPTIONS] [COMMAND]
|
|||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--config-setting</code>, <code>-C</code> <i>config-setting</i></dt><dd><p>Settings to pass to the PEP 517 build backend, specified as <code>KEY=VALUE</code> pairs</p>
|
||||
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</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’s configured time zone.</p>
|
||||
|
|
@ -2608,6 +2678,8 @@ uv tool run [OPTIONS] [COMMAND]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use to build the run environment.</p>
|
||||
|
|
@ -2737,6 +2809,12 @@ uv tool install [OPTIONS] <PACKAGE>
|
|||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--config-setting</code>, <code>-C</code> <i>config-setting</i></dt><dd><p>Settings to pass to the PEP 517 build backend, specified as <code>KEY=VALUE</code> pairs</p>
|
||||
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</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>
|
||||
|
||||
<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’s configured time zone.</p>
|
||||
|
|
@ -2886,6 +2964,8 @@ uv tool install [OPTIONS] <PACKAGE>
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use to build the tool environment.</p>
|
||||
|
|
@ -3013,6 +3093,12 @@ uv tool upgrade [OPTIONS] <NAME>...
|
|||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--config-setting</code>, <code>-C</code> <i>config-setting</i></dt><dd><p>Settings to pass to the PEP 517 build backend, specified as <code>KEY=VALUE</code> pairs</p>
|
||||
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</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’s configured time zone.</p>
|
||||
|
|
@ -3158,6 +3244,8 @@ uv tool upgrade [OPTIONS] <NAME>...
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -3242,6 +3330,12 @@ uv tool list [OPTIONS]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -3273,6 +3367,8 @@ uv tool list [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--quiet</code>, <code>-q</code></dt><dd><p>Do not print any output</p>
|
||||
|
|
@ -3331,6 +3427,12 @@ uv tool uninstall [OPTIONS] <NAME>...
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -3364,6 +3466,8 @@ uv tool uninstall [OPTIONS] <NAME>...
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -3432,6 +3536,12 @@ uv tool update-shell [OPTIONS]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -3465,6 +3575,8 @@ uv tool update-shell [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -3551,6 +3663,12 @@ uv tool dir [OPTIONS]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -3584,6 +3702,8 @@ uv tool dir [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -3726,6 +3846,12 @@ uv python list [OPTIONS]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -3763,6 +3889,8 @@ uv python list [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -3845,6 +3973,12 @@ uv python install [OPTIONS] [TARGETS]...
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -3878,6 +4012,8 @@ uv python install [OPTIONS] [TARGETS]...
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -3956,6 +4092,12 @@ uv python find [OPTIONS] [REQUEST]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -3993,6 +4135,8 @@ uv python find [OPTIONS] [REQUEST]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -4076,6 +4220,12 @@ uv python pin [OPTIONS] [REQUEST]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -4113,6 +4263,8 @@ uv python pin [OPTIONS] [REQUEST]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -4185,6 +4337,12 @@ uv python dir [OPTIONS]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -4218,6 +4376,8 @@ uv python dir [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -4290,6 +4450,12 @@ uv python uninstall [OPTIONS] <TARGETS>...
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -4323,6 +4489,8 @@ uv python uninstall [OPTIONS] <TARGETS>...
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -4472,6 +4640,12 @@ uv pip compile [OPTIONS] <SRC_FILE>...
|
|||
<p>Used to reflect custom build scripts and commands that wrap <code>uv pip compile</code>.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CUSTOM_COMPILE_COMMAND</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--emit-build-options</code></dt><dd><p>Include <code>--no-binary</code> and <code>--only-binary</code> entries in the generated output file</p>
|
||||
|
||||
</dd><dt><code>--emit-find-links</code></dt><dd><p>Include <code>--find-links</code> entries in the generated output file</p>
|
||||
|
|
@ -4661,6 +4835,8 @@ uv pip compile [OPTIONS] <SRC_FILE>...
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code> <i>python</i></dt><dd><p>The Python interpreter to use during resolution.</p>
|
||||
|
|
@ -4862,6 +5038,12 @@ uv pip sync [OPTIONS] <SRC_FILE>...
|
|||
<p>This is equivalent to pip’s <code>--constraint</code> option.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONSTRAINT</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--dry-run</code></dt><dd><p>Perform a dry run, i.e., don’t actually install anything but resolve the dependencies and print the resulting plan</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>
|
||||
|
|
@ -4992,6 +5174,8 @@ uv pip sync [OPTIONS] <SRC_FILE>...
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter into which packages should be installed.</p>
|
||||
|
|
@ -5190,6 +5374,12 @@ uv pip install [OPTIONS] <PACKAGE|--requirement <REQUIREMENT>|--editable <EDITAB
|
|||
<p>This is equivalent to pip’s <code>--constraint</code> option.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONSTRAINT</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--dry-run</code></dt><dd><p>Perform a dry run, i.e., don’t actually install anything but resolve the dependencies and print the resulting plan</p>
|
||||
|
||||
</dd><dt><code>--editable</code>, <code>-e</code> <i>editable</i></dt><dd><p>Install the editable package based on the provided local file path</p>
|
||||
|
|
@ -5362,6 +5552,8 @@ uv pip install [OPTIONS] <PACKAGE|--requirement <REQUIREMENT>|--editable <EDITAB
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter into which packages should be installed.</p>
|
||||
|
|
@ -5557,6 +5749,12 @@ uv pip uninstall [OPTIONS] <PACKAGE|--requirement <REQUIREMENT>>
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--keyring-provider</code> <i>keyring-provider</i></dt><dd><p>Attempt to use <code>keyring</code> for authentication for remote requirements files.</p>
|
||||
|
|
@ -5606,6 +5804,8 @@ uv pip uninstall [OPTIONS] <PACKAGE|--requirement <REQUIREMENT>>
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter from which packages should be uninstalled.</p>
|
||||
|
|
@ -5686,6 +5886,12 @@ uv pip freeze [OPTIONS]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--exclude-editable</code></dt><dd><p>Exclude any editable packages from output</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
|
@ -5721,6 +5927,8 @@ uv pip freeze [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter for which packages should be listed.</p>
|
||||
|
|
@ -5799,6 +6007,12 @@ uv pip list [OPTIONS]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--editable</code>, <code>-e</code></dt><dd><p>Only include editable projects</p>
|
||||
|
||||
</dd><dt><code>--exclude</code> <i>exclude</i></dt><dd><p>Exclude the specified package(s) from the output</p>
|
||||
|
|
@ -5850,6 +6064,8 @@ uv pip list [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter for which packages should be listed.</p>
|
||||
|
|
@ -5934,6 +6150,12 @@ uv pip show [OPTIONS] [PACKAGE]...
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -5967,6 +6189,8 @@ uv pip show [OPTIONS] [PACKAGE]...
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to find the package in.</p>
|
||||
|
|
@ -6048,6 +6272,12 @@ uv pip tree [OPTIONS]
|
|||
</dd><dt><code>--depth</code>, <code>-d</code> <i>depth</i></dt><dd><p>Maximum display depth of the dependency tree</p>
|
||||
|
||||
<p>[default: 255]</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--invert</code></dt><dd><p>Show the reverse dependencies for the given package. This flag will invert the tree and display the packages that depend on the given package</p>
|
||||
|
|
@ -6087,6 +6317,8 @@ uv pip tree [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--prune</code> <i>prune</i></dt><dd><p>Prune the given package from the display of the dependency tree</p>
|
||||
|
|
@ -6169,6 +6401,12 @@ uv pip check [OPTIONS]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -6202,6 +6440,8 @@ uv pip check [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter for which packages should be checked.</p>
|
||||
|
|
@ -6311,6 +6551,12 @@ uv venv [OPTIONS] [PATH]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</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’s configured time zone.</p>
|
||||
|
|
@ -6421,6 +6667,8 @@ uv venv [OPTIONS] [PATH]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--prompt</code> <i>prompt</i></dt><dd><p>Provide an alternative prompt prefix for the virtual environment.</p>
|
||||
|
|
@ -6544,6 +6792,12 @@ uv build [OPTIONS] [SRC]
|
|||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--config-setting</code>, <code>-C</code> <i>config-setting</i></dt><dd><p>Settings to pass to the PEP 517 build backend, specified as <code>KEY=VALUE</code> pairs</p>
|
||||
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</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’s configured time zone.</p>
|
||||
|
|
@ -6701,6 +6955,8 @@ uv build [OPTIONS] [SRC]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use for the build environment.</p>
|
||||
|
|
@ -6997,6 +7253,12 @@ uv cache clean [OPTIONS] [PACKAGE]...
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -7030,6 +7292,8 @@ uv cache clean [OPTIONS] [PACKAGE]...
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -7098,6 +7362,12 @@ uv cache prune [OPTIONS]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -7131,6 +7401,8 @@ uv cache prune [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -7201,6 +7473,12 @@ uv cache dir [OPTIONS]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -7234,6 +7512,8 @@ uv cache dir [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -7296,6 +7576,12 @@ uv version [OPTIONS]
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -7329,6 +7615,8 @@ uv version [OPTIONS]
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
@ -7375,12 +7663,20 @@ uv generate-shell-completion [OPTIONS] <SHELL>
|
|||
|
||||
<h3 class="cli-reference">Options</h3>
|
||||
|
||||
<dl class="cli-reference"><dt><code>--project</code> <i>project</i></dt><dd><p>Run the command within the given project directory.</p>
|
||||
<dl class="cli-reference"><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--project</code> <i>project</i></dt><dd><p>Run the command within the given project directory.</p>
|
||||
|
||||
<p>All <code>pyproject.toml</code>, <code>uv.toml</code>, and <code>.python-version</code> files will be discovered by walking up the directory tree from the project root, as will the project’s virtual environment (<code>.venv</code>).</p>
|
||||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd></dl>
|
||||
|
|
@ -7423,6 +7719,12 @@ uv help [OPTIONS] [COMMAND]...
|
|||
<p>While uv configuration can be included in a <code>pyproject.toml</code> file, it is not allowed in this context.</p>
|
||||
|
||||
<p>May also be set with the <code>UV_CONFIG_FILE</code> environment variable.</p>
|
||||
</dd><dt><code>--directory</code> <i>directory</i></dt><dd><p>Change to the given directory prior to running the command.</p>
|
||||
|
||||
<p>Relative paths are resolved with the given directory as the base.</p>
|
||||
|
||||
<p>See <code>--project</code> to only change the project root directory.</p>
|
||||
|
||||
</dd><dt><code>--help</code>, <code>-h</code></dt><dd><p>Display the concise help for this command</p>
|
||||
|
||||
</dd><dt><code>--native-tls</code></dt><dd><p>Whether to load TLS certificates from the platform’s native certificate store.</p>
|
||||
|
|
@ -7458,6 +7760,8 @@ uv help [OPTIONS] [COMMAND]...
|
|||
|
||||
<p>Other command-line arguments (such as relative paths) will be resolved relative to the current working directory.</p>
|
||||
|
||||
<p>See <code>--directory</code> to change the working directory entirely.</p>
|
||||
|
||||
<p>This setting has no effect when used in the <code>uv pip</code> interface.</p>
|
||||
|
||||
</dd><dt><code>--python-preference</code> <i>python-preference</i></dt><dd><p>Whether to prefer uv-managed or system Python installations.</p>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue